You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue tracks the remaining work, in two waves.
⚠️ Important: #1862's per-module grouping is NOT durable
packages/spec/scripts/build-docs.ts regenerates content/docs/references/** on every gen:docs (which runs in the docs production build: gen:schema && gen:docs && next build). It rmSyncs each category folder and rewrites references/{category}/meta.json as a flat alphabetical list (build-docs.ts:326, 379), plus regenerates every references/{category}/index.mdx (line 420) and references/meta.json (line 448).
So the section grouping added to references/{system,api,…}/meta.json in #1862 gets overwritten the next time anyone runs gen:docs, and likely isn't even reflected on the deployed (Vercel-built) site. The grouping must be moved into the generator to be durable. (The Protocol Overview rename and root content/docs/meta.json are safe — they are outside references/.)
Wave 1 — remaining hand-written docs (82 files)
Audit each against the real implementation in packages/, adversarially verify, apply fixes (surgical, preserve frontmatter, no file moves). Same process as #1866. Exclude references/*/index.mdx (generated).
Improve generated content quality — fill in / improve zod .describe() strings across packages/spec/src/**/*.zod.ts so the generated reference prose is accurate and useful; improve the generator's output formatting where needed.
Re-run gen:docs, verify next build, browser spot-check.
The #1866 pipeline worked well: a multi-agent audit workflow (one agent per doc → locate impl in packages/ → adversarially verify each finding), then an apply workflow (one agent per doc → surgical edits in a dedicated worktree), then next build + browser verify + PR. Note: editing must happen in a dedicated git worktree (the repo's guard-main-checkout hook blocks edits on the shared main checkout).
Continuation of the docs implementation-accuracy effort. Two PRs already landed:
Protocol→Protocol Overview, removed emptycontracts/)This issue tracks the remaining work, in two waves.
packages/spec/scripts/build-docs.tsregeneratescontent/docs/references/**on everygen:docs(which runs in the docs production build:gen:schema && gen:docs && next build). ItrmSyncs each category folder and rewritesreferences/{category}/meta.jsonas a flat alphabetical list (build-docs.ts:326, 379), plus regenerates everyreferences/{category}/index.mdx(line 420) andreferences/meta.json(line 448).So the section grouping added to
references/{system,api,…}/meta.jsonin #1862 gets overwritten the next time anyone runsgen:docs, and likely isn't even reflected on the deployed (Vercel-built) site. The grouping must be moved into the generator to be durable. (TheProtocol Overviewrename and rootcontent/docs/meta.jsonare safe — they are outsidereferences/.)Wave 1 — remaining hand-written docs (82 files)
Audit each against the real implementation in
packages/, adversarially verify, apply fixes (surgical, preserve frontmatter, no file moves). Same process as #1866. Excludereferences/*/index.mdx(generated).The 82 files
content/docs/index.mdxWave 2 — generated references (223 pages) + generator
These live under
content/docs/references/**and are generated, so fixes go to the source, not the.mdx:build-docs.ts(emit---Section---separators in each categorymeta.jsoninstead of a flat sorted list). Define the grouping map there..describe()strings acrosspackages/spec/src/**/*.zod.tsso the generated reference prose is accurate and useful; improve the generator's output formatting where needed.gen:docs, verifynext build, browser spot-check.Smaller follow-ups already flagged
os initscaffold still emits a staleownershipliteral on the starter object (not a validObjectSchemakey). (noticed during docs: sync 46 hand-written docs with actual implementation (reader-facing audit) #1866 quick-start audit)ai-capabilities.mdxfrontmatter still mentions "RAG pipelines" (body was corrected in docs: sync 46 hand-written docs with actual implementation (reader-facing audit) #1866; frontmatter left per preserve-frontmatter rule).Method (reusable)
The #1866 pipeline worked well: a multi-agent audit workflow (one agent per doc → locate impl in
packages/→ adversarially verify each finding), then an apply workflow (one agent per doc → surgical edits in a dedicated worktree), thennext build+ browser verify + PR. Note: editing must happen in a dedicated git worktree (the repo'sguard-main-checkouthook blocks edits on the sharedmaincheckout).