Skip to content

[finding] the 14 generated content/docs/references/*/index.mdx overviews carry no "do not edit" banner, while the 211 pages beside them do #14364

Description

@claude

Found while running the merge=os-regen MIXED-file census for #14064 (PR #14363). Not fixed there — out of scope for that card.

The observation

content/docs/references/** is generated whole by gen:docs (packages/spec/scripts/build-docs.ts), and the sink it uses claims the directory: manageDir(DOCS_ROOT, ...) marks the tree as regenerated wholesale, so flush() deletes what it owns before rewriting. ⇒ a hand edit to any page in that tree is silently discarded by the next gen:docs run.

211 of the tree's 215 .mdx pages say so on the page, in the first 25 lines:

{/* AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

14 do not — every category overview page:

content/docs/references/ai/index.mdx          content/docs/references/qa/index.mdx
content/docs/references/api/index.mdx         content/docs/references/security/index.mdx
content/docs/references/automation/index.mdx  content/docs/references/shared/index.mdx
content/docs/references/cloud/index.mdx       content/docs/references/studio/index.mdx
content/docs/references/data/index.mdx        content/docs/references/system/index.mdx
content/docs/references/identity/index.mdx    content/docs/references/ui/index.mdx
content/docs/references/integration/index.mdx content/docs/references/kernel/index.mdx

They are fully generated all the same — build-docs.ts builds each one line by line (mdx += ... around :875-:895) and emit()s it — so the banner is missing, not the ownership.

Why it is worth a card rather than a shrug

The banner is the ONLY in-page signal that an edit here will not survive. A contributor opening content/docs/references/system/index.mdx (45 lines, ordinary-looking prose plus a Cards list) sees nothing to warn them, edits it, and the change disappears at the next regeneration with no gate red and no conflict — check:docs re-derives the tree, so it reports the page as current after the edit is gone.

⚠️ Measured only as the banner's absence and the generator's ownership. ⛔ I did not find an instance of an edit actually being lost, and I assert no severity.

Scope note

The root content/docs/references/index.mdx DOES carry a banner; only the 14 per-category overviews are missing it. The fix is presumably one template in build-docs.ts §2.5, alongside the existing one used by §2.

Dedup

Searched with a firing control (37 on-topic results, including #13646 and #10834). Closest neighbours, none covering this: #10834 (build-docs.ts:624 bakes a phrase into the generated references index), #4759 (the ROOT references index went stale because the generator preserved it), #12249 (two H1s on generated reference pages). All closed, all different defects.


Generated by Claude Code

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions