Repository navigation
docs: standards page and docs index - #200
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
✅ Reviewed — nothing blocking0 actionable comment(s) · grounded on your code |
Contributor
There was a problem hiding this comment.
Review summary — 3 file(s), 0 finding(s).
Docs-only PR adding docs/standards/README.md, a docs/README.md index and one CLAUDE.md "See also" pointer. Every claim in the standards tables matches the rules and paths stated in CLAUDE.md, and the index mirrors the documented docs tree; nothing in the diff is contradicted by the code or guid…
- test files were not shown to the reviewer — this diff touched no path recognised as a test, so no assertion was available to read the change against
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
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.
What
Add
docs/standards/README.md, the repo's code, structure, testing and gate rules in one page, anddocs/README.md, an index of every page underdocs/.CLAUDE.md"See also" gains one pointer line to the standards page.Why
The repo had no standards page and no docs index: its rules lived across
CLAUDE.md,CONTRIBUTING.md,biome.json,bin/checkand the guard tests.Changes
docs/standards/README.md: each rule cites the file it comes from; every cited path exists.docs/README.md: one row per page underdocs/(standards, reference, adapters how-to,idea/*,claude/SKILL.md, the review-fixes plan).CLAUDE.md: one line under "See also".Verification
dz-contractbefore:ok(0 findings). After:ok(0 findings).bun test src/doc-paths.test.ts src/public-tree.test.ts: 16 pass, 0 fail.bun run lint: 0 errors (new pages formatted with the repo's Biome).