docs: declutter repo root — move plan + benchmark docs into docs/#14
Merged
Conversation
The root listing had 7 planning/benchmark .md files crowding the GitHub home page. Move them out and fix every link: - PLAN-PHASE2..7.md → docs/plan/ - BENCHMARK.md → docs/ (benchmark.mjs now writes there too) - Root keeps only README.md, README.vi.md, CHANGELOG.md, CLAUDE.md, PLAN.md - Updated cross-links in PLAN.md, README*, CHANGELOG.md, CLAUDE.md, and the moved phase files (./PLAN.md → ../../PLAN.md, ./docs/BRAND.md → ../BRAND.md)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The repo-root file listing on the GitHub home page was crowded with 7 planning/benchmark
.mdfiles. This moves them intodocs/so the root stays scannable.Moved
PLAN-PHASE2.md…PLAN-PHASE7.md→docs/plan/BENCHMARK.md→docs/(scripts/benchmark.mjsnow writes todocs/BENCHMARK.md)Root
.mdnow:README.md,README.vi.md,CHANGELOG.md,CLAUDE.md,PLAN.md— that's it.Links fixed (all moves done with
git mv, history preserved):PLAN.md→ phase-table links now point at./docs/plan/…; BENCHMARK link →./docs/BENCHMARK.mdREADME.md,README.vi.md,CHANGELOG.md→ BENCHMARK link →./docs/BENCHMARK.mdCLAUDE.md→ phase-SSOT references →docs/plan/PLAN-PHASE*.md./PLAN.md→../../PLAN.md,./docs/BRAND.md→../BRAND.md(siblingPLAN-PHASE*links unchanged)PLAN.mdstays at root as the roadmap index (keeps the "read PLAN.md first" convention intact).Test plan
pnpm format:check— greenpnpm lint— greenpnpm typecheck— greenpnpm test— 366 passedpnpm build— green