docs: strip build history, fix drift, add missing pages - #11
Merged
Merged
Conversation
Docs were shaped as a pre-release design corpus while the product is a
published 2.0 library. Realigned to public-facing only.
Removed from the site:
- brief, milestones, plan-0.2, plan-1.1 -> docs-internal/ (unpublished)
- contributing/governance.md stub (duplicated appendix/governance)
- process meta-commentary and "as-built" framing throughout
Correctness:
- 42 pages claimed "Stable - 1.0"; packages are 2.0.0. Banners now carry
no version at all - only package/peer facts or a real caveat
- cli.md documented createAgentRuntime({ policies }), removed by ADR-016
- package trees listed 5 packages, omitting postgres and cli
- CJS claim contradicting ADR-012; every command in the dev-setup block
- v0.1 used to mean "today" across 12 pages
- 13 dead #anchors, most pre-existing: vitepress validates link targets
but not fragments
New:
- migration/1-to-2.md, guides/troubleshooting.md, guides/ci-drift-gate.md,
reference/performance.md (measured, not asserted)
Structure: nav split into Guides / Patterns / Releases / Contributing;
index.md 120 -> 73 lines; duplicate arguments given one home each;
ADR-015/016/017 compressed to the house format.
Gates: check:docs now fails on a version in a banner and on an SI/ADR/T/Q/
stage citation above its owning page's maximum. New check:anchors reads ids
back from rendered HTML. Both in CI.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
Full audit of
docs/, then the fixes. The docs were still shaped like a pre-release design corpus — docs-first, "the implementation was built from these" — while the product is a published 2.0 library. Every finding below follows from that mismatch.Correctness
Stable — 1.0; npm has 2.0.0index.mdreference/cli.mddocumentedcreateAgentRuntime({ policies: [...] })AgentRuntimeOptionstakes onlygovernanceindex.mdcited "ADR-001…012"postgresandcliwere documented lower on the same pagecontributing/documentation.mdcapped citations atADR ≤ 012,Q ≤ 11v0.1meaning "today" across 12 pages#anchors, most pre-existingvitepress buildvalidates link targets but not fragments. Em-dash headings emit ids likescope-—-discovery-shaping-…; six pages had guessed the GitHub-style slugHistory and internal notes leave
docs/brief,milestones,plan-0.2,plan-1.1→docs-internal/, unpublished. ~700 lines of imperative instructions to a build that finished, sitting in the published sidebar above the user docs. Also removed: thecontributing/governance.mdstub (duplicatedappendix/governance), and process framing like "these documents are the source of truth the implementation was built from" and "per the review protocol".Structure
index.md120 → 73 lines — the "Documentation map" was re-listing the sidebarwarnings-flag argument, thedefineGovernancerationale,scopevsfilter, and the audit-vs-tracing table each lost their duplicatesNew pages
migration/1-to-2.md— the gap that mattered most. A major shipped with a documented breaking change whose migration lived in an ADR consequences paragraphguides/troubleshooting.md— indexed by what you saw. Startup failures quote the actual strings fromregistry.tsandmeta-validate.tsguides/ci-drift-gate.md— task-first CLI setup; the reference page specified it but never taught itreference/performance.md— measured against the compiled packages, not asserted:call()— oRPC directlyruntime.invoke— no policies, no auditruntime.invoke— 3 policies + audit sink~65 µs of overhead, and policies plus a sink add nothing measurable.
describeat 300 capabilities: 3.03 ms; scoped to a 50-capability tag group: 0.62 ms.getting-startedalso gained a step that runsinvokedirectly and shows the failure envelope — the page previously claimed "the model can now callorders_search" with nothing verifiable before it.Gates, so this can't recur
check:docsnow fails on a version string in a status banner, and on anySI-n/ADR-nnn/Tn/Qn/stage citation above what its owning page defines — read from the source pages, so the caps can't go stale like the hand-written ones didcheck:anchors(new) reads ids back out of the rendered HTML rather than reimplementing the slugifier. In CI afterdocs:buildSource change
Two registry validation messages said "in v0.1" — user-facing strings, so they carry a changeset.
Green: 366 tests ·
check:docs·check:api·check:boundaries·check:capabilities·check:anchors·typecheck·docs:build61 pages / 6,309 lines, from 62 / 6,698 — despite ~390 lines of genuinely new content.