Skip to content

Commit fbec38c

Browse files
committed
docs(spec): regenerate the build-progress and sharing reference pages from their docblocks, and add the patch changeset (stage 31)
gen:docs output only: the two pages follow the module docblocks that now name their decisions in words. The changeset records the shipped comment text. Claude-Session: https://claude.ai/code/session_01DhTqaEHqPVSVnAkjG3jywn Co-authored-by: Claude <noreply@anthropic.com>
1 parent 74853d7 commit fbec38c

3 files changed

Lines changed: 23 additions & 7 deletions

File tree

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
'@objectstack/spec': patch
3+
---
4+
5+
Source comments that cited a tracker number now say in words which decision they mean, and the pin tests that read those comments match the new words
6+
7+
Clause-②: no
8+
9+
The package ships its `src/**/*.zod.ts` sources, and `dist` carries the member docblocks. Four of those texts named a decision only by its tracker number. Each now names the decision in words. The pin test that reads each text matches the new words, at the places the old number stood:
10+
11+
- `ai/build-progress.zod.ts`: the cloud card that ruled the build-progress phase vocabulary in, and that owns where the emitter sits, is now "the cloud build-progress card" in all seven places. The consumer's strict-parse carrier is "block 2 of the objectui build-panel card". The `ai/build-progress` reference page is regenerated from the module docblock, so its description now ends with "(the cloud build-progress card, ruling A)".
12+
- `contracts/approval-service.ts`: the `IApprovalService.continueRestoredRun` docblock says the verb is declared "exactly as the automation-service contract declared" `IAutomationService.cancelRun` / `restoreConsumedSuspension`.
13+
- `ui/notification.zod.ts`: the tombstone note for the removed `./ui` `Notification` / `NotificationConfig` wrappers is labelled `[dual-source removal]`. The `NotificationAction` removal is called "the no-door retirement".
14+
- `ui/sharing.zod.ts`: `EmbedConfigSchema` is recorded as removed "at the no-door retirement (ADR-0049 enforce-or-remove)". The `ui/sharing` reference page is regenerated from the module docblock.
15+
16+
Comments and docblocks only. No key, type, default, accepted value, `.describe()` string or export changes.

‎content/docs/references/ai/build-progress.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Build Progress schema — AI Protocol reference
33
navTitle: Build Progress
4-
description: "Build-progress PHASE vocabulary for the data-build-progress stream frame."
4+
description: "Build-progress PHASE vocabulary for the data-build-progress stream frame (the cloud build-progress card, ruling A)."
55
---
66

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

99
Build-progress PHASE vocabulary for the `data-build-progress` stream frame
10-
(cloud#2172 ruling A).
10+
(the cloud build-progress card, ruling A).
1111

1212
## How to read the claims in this module
1313

@@ -26,7 +26,7 @@ therefore carries exactly one of three labels, and none is left bare:
2626
## Producer
2727

2828
The cloud AI-studio **agent loop** — deliberately not the tool it just ran.
29-
**Declared by ruling**: cloud#2172 ruling A owns WHERE in the loop a frame is
29+
**Declared by ruling**: the cloud build-progress card's ruling A owns WHERE in the loop a frame is
3030
emitted; this module declares only what such a frame may SAY.
3131

3232
A build turn applies its change through `apply_blueprint` / `apply_edit` and
@@ -76,15 +76,15 @@ repository reachable from here they have zero emitters and zero readers
7676
(**measured on named reachable sources** — each reading is recorded in the
7777
source beside its surface: on `BUILD_PROGRESS_PHASES` for the phase, and on
7878
the `hop` / `tool` field declarations). They stand on a ruling instead
79-
(**declared by ruling**): cloud#2172 ruled the vocabulary in, and
79+
(**declared by ruling**): the cloud build-progress card ruled the vocabulary in, and
8080
objectui#7388 asked the panel to be able to name the phase. That is a good
8181
reason, and it is not a measurement.
8282

8383
⛔ No gate watches this. The ADR-0049 liveness ledger is rooted in the
8484
metadata-type registry, and `BuildProgressFrame` is not a registered
8585
metadata type, so the liveness job stays green however long these three go
86-
unused. Two named carriers are meant to close it — cloud#2172 for the
87-
emitter, objectui#7388 block 2 for the consumer's strict parse. If neither
86+
unused. Two named carriers are meant to close it — the cloud build-progress card for the
87+
emitter, block 2 of the objectui build-panel card for the consumer's strict parse. If neither
8888
lands, the three become enforce-or-remove candidates with nothing watching
8989
them, and the only thing that notices is a person reading this paragraph.
9090

‎content/docs/references/ui/sharing.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ asymmetry survives as the reason this file reads the way it does:
2424
`@objectstack/metadata-core` re-exports to the server's doors). Both
2525
example apps author it (`app-showcase` `inquiry.view.ts`, `app-crm`
2626
`lead.view.ts`). It is `strictObject` as of #4001 批 14.
27-
- `EmbedConfigSchema` was **REMOVED** at #5015 (ADR-0049 enforce-or-remove) —
27+
- `EmbedConfigSchema` was **REMOVED** at the no-door retirement (ADR-0049 enforce-or-remove) —
2828
see the block below where it stood.
2929

3030
The ledger's classification question is *"who writes this schema's input?"*,

0 commit comments

Comments
 (0)