Skip to content

docs: polish public repo presentation#1

Draft
eiler2005 wants to merge 11 commits into
masterfrom
docs/public-repo-polish-2026-06-16
Draft

docs: polish public repo presentation#1
eiler2005 wants to merge 11 commits into
masterfrom
docs/public-repo-polish-2026-06-16

Conversation

@eiler2005

Copy link
Copy Markdown
Owner

Summary

  • Add a product requirements brief and testing strategy guide so reviewers can understand scope, non-goals, quality attributes and verification boundaries quickly.
  • Tighten docs navigation, contributing guidance, env examples, ignore rules and local Node version alignment.
  • Add a PR template and public repo review snapshot focused on hiring presentation, security hygiene and next steps.

Scope

Docs/repo hygiene only. No router, VPS, Ansible playbook, routing, Console runtime or generated artifact behavior changed.

Touched areas:

  • docs/
  • CONTRIBUTING.md
  • .env.example
  • .gitignore
  • .nvmrc
  • .github/pull_request_template.md
  • modules/ghostroute-console/app/.env.example

Tests

Not run in this GitHub-only review session:

  • local secret-scan
  • repo fixture tests
  • Console build/tests
  • live router/VPS verification

Recommended before merge:

./modules/secrets-management/bin/secret-scan
./tests/run-fast.sh
./tests/run-smoke.sh
bash -n verify.sh tests/run-all.sh tests/run-fast.sh

npm --prefix modules/ghostroute-console/app ci
npm --prefix modules/ghostroute-console/app test
npm --prefix modules/ghostroute-console/app run build

Risk and rollback

Risk is low because the PR is documentation and repo hygiene only. The main review points are:

  • confirm .gitignore does not hide any intended new local-dev examples;
  • confirm the new docs do not overstate implemented behavior;
  • run the secret scan before merge.

Rollback: revert or close this PR. No live runtime state was touched.

Secrets and public-safety check

  • No real endpoints, listener ports, credentials, UUIDs, Reality keys, short IDs, admin paths, QR payloads, VLESS URIs, provider details or personal device identifiers were added.
  • Public examples use placeholders such as <router_lan_ip>, <remote-router-ssh-host>, <console-host> and <console-port>.
  • Generated artifacts and local reports remain gitignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant