Continues the new-developer journey audit (#10264), which covered the README and the running product but could not reach the docs site. The site is served from this repo, so the audit is content/docs/**.
Scope — exactly these, nothing else
content/docs/ui/**, content/docs/automation/**, content/docs/permissions/**, content/docs/ai/** (~50 pages).
Explicitly out of scope, do not touch or audit:
content/docs/references/** — 214 auto-generated pages (⚠️ AUTO-GENERATED — DO NOT EDIT, produced by packages/spec/scripts/build-docs.ts). A defect there is a generator bug; file it against the generator, do not hand-edit.content/docs/releases/** — written centrally at release time. Never edit in a code PR.- Everything covered by card 1/2 (
index.mdx, build-without-code.mdx, getting-started/, concepts/, data-modeling/).
Already machine-covered — do not re-derive
These gates were run on origin/main before dispatch:
| Gate | Result |
|---|
check:doc-authoring | ✓ 380 files clean, no bare metadata literals |
check:docs-redirects | ✓ 92 entries, all destinations resolve |
check:doc-anchors | exists and runs in CI (needs node_modules locally) |
So anchors, redirect integrity and metadata literals are the machine's job. Spend nothing on them. Your job is what no gate can see.
Method — cheap checks first, prose reasoning last
This ordering is the point of the card; inverting it burns budget for little yield.
- Mechanically falsifiable claims first. Every identifier a doc names — a field type, a schema property, a method, a CLI flag, an option key — either exists in
packages/spec / the implementing package or it does not. That is a grep, not a reading exercise. Sweep the identifiers out of the code fences and check them in bulk against source. Docs naming things that no longer exist is the highest-yield, cheapest defect class here — and this slice is where retirements bite hardest, because ui, automation and permissions have all had properties removed under enforce-or-remove. - Runnable claims second. Commands and code samples a reader is invited to run.
- Pedagogical holes last. Read as a stranger who has just modelled their first object and now wants a view, a flow, an action and a permission posture.
Two known holes to check specifically
Both were measured in #10264 against the product and the skills bundle. Establish whether the docs have the same holes, or whether the docs already cover what the skills missed — either answer is directly useful:
Deliverable
Audit-only. Do not open a PR and do not edit any doc. File one finding issue per distinct defect, unassigned, finding label only — no domain and no type label, those are the triage seat's product. Dedupe-search before each one (#10317 and #10318 already exist — add to them rather than filing twins). Back-link this issue.
Report as a comment here: pages audited, defects found by class, findings filed with numbers, hit rate per page, and a direct answer on the two known holes above.
Continues the new-developer journey audit (#10264), which covered the README and the running product but could not reach the docs site. The site is served from this repo, so the audit is
content/docs/**.Scope — exactly these, nothing else
content/docs/ui/**,content/docs/automation/**,content/docs/permissions/**,content/docs/ai/**(~50 pages).Explicitly out of scope, do not touch or audit:
content/docs/references/**— 214 auto-generated pages (⚠️ AUTO-GENERATED — DO NOT EDIT, produced bypackages/spec/scripts/build-docs.ts). A defect there is a generator bug; file it against the generator, do not hand-edit.content/docs/releases/**— written centrally at release time. Never edit in a code PR.index.mdx,build-without-code.mdx,getting-started/,concepts/,data-modeling/).Already machine-covered — do not re-derive
These gates were run on
origin/mainbefore dispatch:check:doc-authoringcheck:docs-redirectscheck:doc-anchorsnode_moduleslocally)So anchors, redirect integrity and metadata literals are the machine's job. Spend nothing on them. Your job is what no gate can see.
Method — cheap checks first, prose reasoning last
This ordering is the point of the card; inverting it burns budget for little yield.
packages/spec/ the implementing package or it does not. That is agrep, not a reading exercise. Sweep the identifiers out of the code fences and check them in bulk against source. Docs naming things that no longer exist is the highest-yield, cheapest defect class here — and this slice is where retirements bite hardest, becauseui,automationandpermissionshave all had properties removed under enforce-or-remove.Two known holes to check specifically
Both were measured in #10264 against the product and the skills bundle. Establish whether the docs have the same holes, or whether the docs already cover what the skills missed — either answer is directly useful:
sys_user_permission_setand it is not exposed over MCP. Do the permissions docs document assignment, or do they also stop at authoring?ui/docs state that an App is required, and would a reader following them in order learn it before they hit the empty Console?Deliverable
Audit-only. Do not open a PR and do not edit any doc. File one
findingissue per distinct defect, unassigned,findinglabel only — no domain and no type label, those are the triage seat's product. Dedupe-search before each one (#10317 and #10318 already exist — add to them rather than filing twins). Back-link this issue.Report as a comment here: pages audited, defects found by class, findings filed with numbers, hit rate per page, and a direct answer on the two known holes above.