Skip to content

Commit b0e155a

Browse files
committed
docs(spec): regenerate the fourteen reference pages the marker opened
`pnpm --filter @objectstack/spec gen:docs` after the renderer fix. Every page loses exactly two lines — its `@module <path>` marker and the blank line under it — and none gains any, so no page loses prose. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GDA48PuRFrHyRfdkBz8m21
1 parent 32d9dcf commit b0e155a

15 files changed

Lines changed: 14 additions & 28 deletions
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
'@objectstack/spec': patch
3+
---
4+
5+
Reference pages no longer open with the `@module` marker line. That tag is what
6+
tells the docs generator which doc block describes the module, but it is
7+
machinery for the selector, not prose — and the renderer emitted it verbatim, so
8+
fourteen published pages opened on the literal text `@module ui/sharing` instead
9+
of on their first sentence. `renderFileDescription` now drops the marker at prose
10+
level, exactly as it already drops the `check:skill-examples` opt-in marker, and
11+
as the skill-index extractor has always done. The marker stays in the source and
12+
still selects the block; only `@module` is dropped, because `@example` and
13+
`@category` carry prose a line-drop would take off the page. No schema behavior
14+
changes.

content/docs/references/automation/bpmn-interop.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Bpmn Interop protocol schemas
55

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

8-
@module automation/bpmn-interop
9-
108
BPMN XML Interoperability Protocol
119

1210
Defines the specification for importing and exporting BPMN 2.0 XML

content/docs/references/automation/builtin-node-config.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Builtin Node Config protocol schemas
55

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

8-
@module automation/builtin-node-config
9-
108
Config contracts for the remaining flat builtins — the CRUD quartet
119
(`get_record` / `create_record` / `update_record` / `delete_record`),
1210
`screen`, and `map` (#4045). Sibling of `io-node-config.zod.ts`

content/docs/references/automation/control-flow.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Control Flow protocol schemas
55

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

8-
@module automation/control-flow
9-
108
Structured control-flow constructs (ADR-0031) — the **native + AI-authored**
119
flow model: a `loop` **container**, a `parallel` **block**, and structured
1210
`try/catch/retry`. Unlike BPMN's gateway/boundary/token graph (kept in the

content/docs/references/automation/flow-function.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Flow Function protocol schemas
55

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

8-
@module automation/flow-function
9-
108
The contract for a **named handler function a `script` node invokes**
119
contributed by `defineStack({ functions })` and resolved by name at execute
1210
time (#1870).

content/docs/references/automation/io-node-config.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Io Node Config protocol schemas
55

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

8-
@module automation/io-node-config
9-
108
Config contracts for the flat IO builtins — `notify` and `http` (#4045).
119

1210
## Provenance — written from the executors, not from the forms

content/docs/references/automation/node-executor.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Node Executor protocol schemas
55

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

8-
@module automation/node-executor
9-
108
Node Executor Plugin Protocol — Wait Node Pause/Resume
119

1210
Defines the specification for node executor plugins, with a focus on

content/docs/references/automation/schemaless-node-config.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Schemaless Node Config protocol schemas
55

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

8-
@module automation/schemaless-node-config
9-
108
Config contracts for the **descriptor-schemaless** builtins whose designer
119
form lives ONLY in objectui's hand-written `FLOW_NODE_CONFIG` table —
1210
`script`, `subflow` and `decision` (#4278).

content/docs/references/automation/state-machine.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: State Machine protocol schemas
55

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

8-
@module automation/state-machine
9-
108
XState-inspired State Machine Protocol — hierarchical states, guarded
119
transitions, entry/exit actions. Used to declare strict business-logic
1210
constraints and lifecycle management, so an AI author cannot "hallucinate" a

content/docs/references/shared/mapping.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Mapping protocol schemas
55

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

8-
@module shared/mapping
9-
108
Base Field Mapping Protocol
119

1210
Shared by: Connector

0 commit comments

Comments
 (0)