Skip to content

docs: standards page and docs index - #200

Merged
sebyx07 merged 1 commit into
mainfrom
dz/docs-standards
Nov 19, 2026
Merged

sebyx07 merged 1 commit into
mainfrom
dz/docs-standards

Conversation

@sebyx07

@sebyx07 sebyx07 commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

What

Add docs/standards/README.md, the repo's code, structure, testing and gate rules in one page, and docs/README.md, an index of every page under docs/. 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/check and 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 under docs/ (standards, reference, adapters how-to, idea/*, claude/SKILL.md, the review-fixes plan).
  • CLAUDE.md: one line under "See also".

Verification

  • dz-contract before: 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).
  • Cited paths checked to exist.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@developerz-ai

developerz-ai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

✅ Reviewed — nothing blocking

0 actionable comment(s) · grounded on your code

⚠️ 1 config note(s): 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

@developerz-ai developerz-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@sebyx07
sebyx07 merged commit 4fd9164 into main Nov 19, 2026
3 checks passed
@sebyx07
sebyx07 deleted the dz/docs-standards branch November 19, 2026 02:27
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