Skip to content

Commit 7a17f3b

Browse files
claude[bot]claude
andauthored
fix(spec): emit the "do not edit" banner on the generated category overviews (#14731)
`content/docs/references/**` is claimed by `manageDir(DOCS_ROOT, …)`, so `flush()` deletes what it owns before rewriting — a hand edit to any page in that tree is discarded by the next `gen:docs` run with no gate red and no conflict, because `check:docs` re-derives the tree and then reports it current. The banner is the only in-page signal a contributor gets before that happens. 200 of the tree's 214 pages carried it. The 14 that did not were the per-category overviews: the §2.5 template built each page line by line and never emitted the line §2 emits for every schema page. Ownership was never in doubt, only the warning. The banner string now lives in one place — `AUTO_GENERATED_BANNER` in `lib/generated-output.ts`, the sink module whose `manageDir()` claim the banner announces — and all three emission sites use it: §2 (schema pages), §2.5 (category overviews, new) and `lib/root-index.ts` (the root index, which already carried its own identical copy of the literal). One spelling, so a future reword cannot split the tree into two populations of page. The 14 overviews are re-emitted by the generator, not hand-edited; the other 200 pages and the root index come out byte-identical, which `check:generated` proves. `scripts/references-banner.test.ts` asks the question of the TREE rather than of a template: every `.mdx` under `content/docs/references/` carries the banner in its first 25 lines, banner-less set empty, with a page-count floor and a non-empty-banner guard so the walk cannot pass vacuously. Claude-Session: https://claude.ai/code/session_017RbbUMnxkUnWhE4j94v8FE Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5258b63 commit 7a17f3b

18 files changed

Lines changed: 157 additions & 3 deletions

File tree

‎content/docs/references/ai/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: AI Protocol
33
description: Complete reference for all ai protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the ai layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/api/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: API Protocol
33
description: Complete reference for all api protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the api layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/automation/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Automation Protocol
33
description: Complete reference for all automation protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the automation layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/cloud/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Cloud Protocol
33
description: Complete reference for all cloud protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the cloud layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/data/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Data Protocol
33
description: Complete reference for all data protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the data layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/identity/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Identity Protocol
33
description: Complete reference for all identity protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the identity layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/integration/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Integration Protocol
33
description: Complete reference for all integration protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the integration layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/kernel/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Kernel Protocol
33
description: Complete reference for all kernel protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the kernel layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/qa/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: QA Protocol
33
description: Complete reference for all qa protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the qa layer of ObjectStack.
79

810
<Cards>

‎content/docs/references/security/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Security Protocol
33
description: Complete reference for all security protocol schemas
44
---
55

6+
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
7+
68
This section contains all protocol schemas for the security layer of ObjectStack.
79

810
<Cards>

0 commit comments

Comments
 (0)