Skip to content

gate(doc-types): walk packages/NAME/README.md, with its ruled DOC_TYPE_EXEMPTIONS entries - #9996

Open
os-try-charles wants to merge 2 commits into
mainfrom
claude/issue-8115-doc-type-exemptions-package-readmes
Open

os-try-charles wants to merge 2 commits into
mainfrom
claude/issue-8115-doc-type-exemptions-package-readmes

Conversation

@os-try-charles

Copy link
Copy Markdown
Collaborator

Fixes #8115
Part of #7896 — ⛔ #7896 is not addressed in full here; its acceptance is a reading the PM takes at landing.

check:doc-types now walks every packages/NAME/README.md, and the ruled DOC_TYPE_EXEMPTIONS entries land with it.

Why one PR — the ruling, not the card face

Triage 5582405961 ruled option A; 5594701696 answered the follow-up pm:retriage with reading A₁: the ruled entries land in the live table together with #7896's fourth leg, in one change. This card's own fence (⛔ do not land the leg) is overridden by that ruling. A₂ is not available: an entry whose (file, value) the walk never reaches fails as stale-exemption, so entries-first collapses into option C, which 5582405961 excluded as dominated.

The census, re-derived — ⛔ no number inherited

Re-derived on 5585ba55a's base edbcf1e7a with this gate's own deriveRegistryKeys, its fence walker and its type matcher over all 39 packages/NAME/README.md:

README files: 39 | blocks: 396 | type literals: 243 | registry keys: 648
unregistered sites: 28 across 8 file(s) | distinct (file,value) pairs: 25

The widened gate's own first run agrees to the site: 28 findings, and its counter deltas match the standalone instrument exactly (blocks 1107 → 1503 = +396; type literals 901 → 1144 = +243).

⚠️ The formal acceptance wording "22 entries covering 25 sites" no longer holds, and the card's "26 across 12 files" never did. The 12 was corrected to 8 by 5582405961; the gate header's 26 … across 8 files reading was anchored to c30026715 and is stale too. Today it is 25 entries covering 28 sites. The 22/25 shape survives — the table is keyed by (file, value), plugin-grid's multiple covers 3 sites and plugin-dashboard's line covers 2 — only the numbers moved. A reviewer counting 28 rows against 25 correct entries would read correct work as unfinished.

Net of the two predecessor cards, now completed: the activity-timeline site (objectui#8114) and the flow node action site (objectui#8483) are both gone from the census, and four sites the earlier reading did not carry are now in it.

The falsifiable zone — the absence, proven

The claim is not "the gate is green"; it is that a mutated component type in a package README cannot pass any more. Before the leg it passed with byte-identical counters, which is the proof the file was outside the scan population rather than judged and forgiven. Every mutation proved on disk by counting the injected and removed text, every restore by git hash-object equality against the HEAD blob.

run mutation exit counters
before packages/app-shell/README.md object-viewobject-vieeew 0 188 / 1107 / 901, registered 782 — byte-identical to the unmutated run
before, positive control root README.md gridgriiid 1 at README.md:84 registered 782 → 781
after the same package-README mutation 1 at packages/app-shell/README.md:62 227 / 1503 / 1144, registered 997 → 996 — the counters MOVE
after, positive control the same root-README mutation 1 at README.md:84 registered 997 → 996

The control fires in both states, so the zero above is a reading about the tree and not about a broken instrument.

The two couplings, both taken

  1. Slot. The leg sits before the root pages in scanDocs — the slot the two sibling walks append it in, which is what keeps the three document lists comparable element by element.
  2. The carriage census. check-doc-expression-carriage.mjs imports this gate's surface constants and pins its own walk as an equality against a walk rebuilt from those constants, not against this gate's actual walk — so a leg added here alone leaves that pin GREEN while the two surfaces diverge, finding(docs/gate): the root README's flagship dashboard example teaches stat-card, which nothing registers — and the root README is outside every doc gate's scan surface #7115's shape rebuilt inside the instrument written to prevent it. That census now takes the same leg through PACKAGE_READMES / packageReadmePages, its SURFACE_LABEL names it, and both walks read 227 documents.

Ablation, on the committed state, each with on-disk and restore proof. Removing the leg from the carriage census alone — leaving this gate's leg in place, which is exactly the silent-divergence shape — turns 2 pins red (walks exactly the document set that surface names, reaches every leg of the walk). Removing it from this gate turns 7 red. Before this change that divergence was invisible in both directions.

The entries are rulings, ⛔ not a green switch

5556586208 binds and the gate's own header is explicit that stuffing the table here "would bury the one real defect among 25 entries nobody read". Every entry names its vocabulary and where that vocabulary is declared, cited by symbol rather than by a cross-file line address (AGENTS.md #11).

file values vocabulary · declaration
app-shell autolaunched FlowSchema.type, the flow PROCESS-KIND enum — a different vocabulary from the four below, four lines away in the same block
app-shell start decision notify end FlowNodeAction (@objectstack/spec). start/end are the two FLOW_STRUCTURAL_NODE_TYPES, which is why they are in the enum and absent from NODE_PALETTE
mobile swipe-left swipe-right GestureType⚠️ not the useGesture/useSpecGesture hook pair the census cited; the hooks consume the union, they do not declare it
mobile pinch SpecGestureType via SPEC_GESTURE_TYPES — a different union from GestureType, and pinch is a member of both
plugin-dashboard line pie bar DashboardWidgetTypeName, whose spec half is ChartTypeSchema by reference
plugin-gantt milestone GanttTaskType
plugin-gantt fs ss ff sf GanttLinkType — a different vocabulary from the task kind, same file
plugin-grid multiple SelectionConfigSchema.type (3 sites)
plugin-grid count_unique ColumnSummarySchema, reused by ColumnSummaryConfigSchema
plugin-kanban kanban ⚠️ the one value in the group belonging to the vocabulary this gate judges — the bare node key retired by #8802, spelled deliberately in a warning comment; declared by RetiredKanbanNodeSchema = retiredNodeType('kanban', …). Re-register the key and this entry reports stale-exemption
plugin-report matrix joined SpecReportTypeName
plugin-report bar ⚠️ a chart type under chart.type, ⛔ not a report kindChartTypeSchema, planned by planReportChart. The census filed it with its neighbours; recorded here as a correction
plugin-view share kanban date-range ObjectViewSchema.viewActions[].type, ViewType, FilterUISchema.filters[].type

Two sites are deliberately absent — they were re-classified as defects and repaired on their own cards, objectui#8114 and objectui#8483. ⭐ No new site was reclassified in this pass: all 25 took the treatment, each with a declaration site in source.

Which pin covers the new entries

every package-README exemption names a vocabulary and a declaration site in check-doc-component-types.test.ts. It reads all 25 entries (asserted non-vacuously), requires each to cite at least two backticked things and to either name a declaring symbol or defer explicitly to the sibling entry that does, and asserts zero stale-exemption findings tree-wide. ⛔ Its first draft used a length floor, which failed a perfectly good GanttLinkType sibling at 119 characters while passing any padded stub at 121 — a character count is a proxy for teaching and was replaced with the substance.

Two claims this branch made false, repaired

  • check-doc-snippet-types.mjs's ownership matrix said packages/NAME/README.md is for this gate, and gave as the reason that "a package README teaches its own package's API rather than the schema vocabulary" — measured false: they teach 243 type literals.
  • check-doc-fence-languages.test.ts said this gate "cannot join that comparison" because its surface does not include the package READMEs. The leg now has its own cross-gate pin instead of a sentence.

Surface shrink, guarded

The leg is collected by walk, not by name, so it cannot dangle the way a ROOT_PAGES entry does — it just returns fewer files while every printed count stays plausible. The CLI therefore refuses to publish a verdict when the leg collects nothing, and a pin drives that refusal.

The ledger markdown-test-inputs.mjs owed two packages/** entries: it is the class a markdown-only pull request consults to decide whether the shard that READS that markdown runs at all, and #8857 was a pull request changing exactly one package README whose shard reported success in ten seconds having run nothing.

Verification

Run through os-verify-lock.sh; exit codes captured by redirecting to a file before reading $?, never across a pipe.

check result
node scripts/check-doc-component-types.mjs 0 — 227 files, 1503 blocks, 1144 literals, 997 registered, 147 exempted, 5 key tables / 61 keys all registered
node scripts/check-doc-expression-carriage.mjs 0 — 227 files across the named surface
node scripts/check-doc-fence-languages.mjs 0
pnpm exec vitest run scripts/ 0 — 175 files, 5242 passed, 2 skipped
pnpm exec tsc -p tsconfig.scripts.json --noEmit 0
check-changeset-presence 0 — "0 of them published source … no changeset is owed"
check-governed-queue-guard --test 0 — NOT GOVERNED, 6 paths against 5 surfaces
check-new-cross-file-line-citations 0 (report-only) — see note below
eslint, targeted 0 errors, 0 warnings over the 7 changed files

The check:doc-snippets gate is NOT MEASURED here, by its own refusal: PRECONDITION NOT MET (exit 2) — The snippet program was NOT run, the workspace being unbuilt. That is "I could not look", not a verdict. This branch's change to that file is comment-only (verified: every non-comment line in its diff is empty), so its behaviour is unchanged; CI builds and runs it.

Lint narrowing, declared. The repo-wide population is 5154 files by eslint's own config; the targeted run covered the 7 changed files, counts read from --format json. Invariance: eslint.config.js configures no type-aware program (no project / projectService), so this diff cannot move the verdict on any file it does not touch. Repo-wide there are 95 pre-existing errors across 79 files on main; none is in this diff. Measured on 5585ba55a.

The one line-citation hit is 'unregistered-doc-type :: packages/demo/README.md:2 :: stat-card' — an expected-string assertion on the gate's own computed diagnostic over a throwaway fixture tree, which the gate itself resolves as unresolvable (ambiguous-basename). It is not a stored citation into a real file; it is the same shape as the pre-existing root-README.md pin beside it. Report-only, exit 0.

维护者速读(草稿)

改了什么check:doc-types 现在走 packages/NAME/README.md,并带上 25 条已裁定的豁免条目;姊妹的 carriage 普查同步取这条腿。

为什么改 — 这些 README 随 npm 包一起发出去,它们的 type 被两个姊妹门禁读过两遍、被谁都没判过。读者照抄一个不存在的 type,拿到的是红色 OBJUI-001 面板。这正是 #7115 的老毛病换了个目录重演。

风险与代价(含回滚) — 门禁扫描面从 188 个文档扩到 227 个,首跑红了 28 处,全部是别的词汇表、各自有源码声明点,逐条裁定后转绿。⛔ 没有削弱任何既有检查。回滚 = revert 这两个 commit,扫描面回到 188,豁免条目随之消失(它们键控的文件不再在 walk 内,留着会报 stale-exemption)。

席位意见 — (留空)

你要做的 — 复核那 25 条裁定的措辞是否站得住(尤其 plugin-kanbankanban:它是本组里唯一属于本门禁所判词汇表的值,理由是"已退役、故意写出来教人认出拒收");以及 A₁ 这个读法是否仍是你要的。PR 停在 draft,不翻 ready、不入队。


⛔ Draft. Not flipped to ready, not enqueued, nothing approved or merged.

🤖 Generated with Claude Code

https://claude.ai/code/session_015h79niBMyoB1xcaQje3uiz


Generated by Claude Code

…s ruled exemptions

objectui#7896's fourth leg and objectui#8115's ruled `DOC_TYPE_EXEMPTIONS`
entries, in one change because the gate admits no other order: an entry whose
(file, value) the walk never reaches fails as `stale-exemption`.

A package README ships to npm inside that package's `files` list, and its `type`
literals were read TWICE — `check-doc-snippet-types` compiles their `ts` fences,
`check-doc-fence-languages` labels every fence in them — and judged by NOTHING.
objectui#7115's geometry one directory over.

- New leg `PACKAGE_READMES` / `packageReadmePages`, non-recursive, in the slot
  the two sibling walks append it in: BEFORE the root pages.
- `check-doc-expression-carriage` takes the SAME leg. Its surface pin rebuilds
  the expected list from the imported constants and compares it against its own
  walk, so a leg added to the component gate alone leaves that pin green while
  the two surfaces diverge. `SURFACE_LABEL` names the leg.
- 25 `DOC_TYPE_EXEMPTIONS` entries covering 28 sites, each naming its vocabulary
  and where that vocabulary is declared. Two sites of the original census are
  deliberately absent: they were re-classified as defects and fixed on their own
  cards (objectui#8114, objectui#8483).
- The CLI refuses to publish a verdict when the new leg collects nothing — it is
  collected by walk rather than by name, so it cannot dangle, it just shrinks.
- Repairs two claims this branch makes false: the ownership matrix row in
  `check-doc-snippet-types` and the sentence in `check-doc-fence-languages.test`
  that said this gate could not join the cross-gate surface pins.

Co-authored-by: Claude <noreply@anthropic.com>
…k now reads

`markdown-test-inputs.mjs` is the class a markdown-only pull request consults to
decide whether the shard that READS that markdown runs at all. The fourth leg
put every `packages/NAME/README.md` into `check:doc-types`' walk and into the
carriage census that imports its surface, so both tests now read them and the
ledger owed two `packages/**` entries.

Over-declaring is the safe direction: objectui#8857 was a pull request changing
exactly ONE package README, and its shard reported success in ten seconds having
run nothing. Same entry shape `check-doc-snippet-types.test.ts` already carries
for the same surface; the ledger has no `dir/*/name` form.

Also drops an unnecessary regex escape the lint rule flagged.

Co-authored-by: Claude <noreply@anthropic.com>
@os-try-charles os-try-charles added domain:devx objectui devx stream: fix lands on .github/, scripts/ or release pipeline — devx lane cross-repo tooling labels Sep 19, 2026 — with Claude
@github-actions github-actions Bot added the tests label Sep 19, 2026
@github-actions

Copy link
Copy Markdown
Contributor

changeset-claim-re-read

⚠️ 3 pending changeset(s) describe a file this change touches

Their bodies publish verbatim into the CHANGELOG at the next release, so this is a request to re-read them against your diff — addressed here because you are the one seat that can answer it without re-deriving anything.

⛔ Nothing here blocks, and nothing here is a verdict on your change. This gate exits 0, is not a required context, and judges name resolution, never meaning: it asked whether a pending body names a file you touched. "Is this sentence still true?" is the one question it will not answer, and the one you are being asked to answer.

.changeset/8114-detail-tab-activity-timeline.md

  • names scripts/check-doc-component-types.mjsscripts/check-doc-component-types.mjs — edited by this change

    Which type replaces it was read off the registry rather than guessed, using the repository's own derivation — deriveRegistryKeys() from scripts/check-doc-component-types.mjs, the 649-key universe that gate judges against:

.changeset/8499-node-slot-registered-arms.md

  • names scripts/check-doc-component-types.mjsscripts/check-doc-component-types.mjs — edited by this change

    The defect, and the direction it ran. Nine type spellings sat at DECLARED node slots in this repository's own corpora and resolved in no arm of the component union. Eight were registered renderers with fixtures proving they draw; the ninth (my-component) is the reader's own plugin component and carries a written exemption in scripts/check-doc-component-types.mjs. A reader following content/docs/utilities/runner.mdx's own instruction — "copy one, wrap it in a page document … and save it as src/app-data/pages/index.json" — got a document that renders correctly in the browser and is refused by objectui check. That is the expensive direction: the likely reaction is to stop trusting the validator.

.changeset/9533-dashboard-bare-key-converge-plugin-namespace.md

  • names scripts/check-doc-component-types.mjsscripts/check-doc-component-types.mjs — edited by this change

    What changed. The renderer registers as plugin-dashboard:dashboard, the namespace every sibling plugin, both console stubs and the CLI whitelist already use, so the console stubs are cleared on load and all three claimants of the bare key name ONE full type. The retired view:dashboard key answers RetiredDashboardNodeTombstone — an inline refusal, plus a console.error carrying the same text — registered with skipFallback: true so it claims no bare key. Its spelling is withheld from the derived key universe by declaration in scripts/check-doc-component-types.mjs, the same disposition the RETIRED_FIELD_TYPES tombstones take, so objectui check names it rather than blessing it; packages/cli/src/utils/known-schema-types.ts regenerates and loses that one entry.

Read the paragraph, not the line: both false halves of the objectui#8617 claim sat in one paragraph, and correcting either alone would have left it asserting the same wrong thing.

If a claim did go false, correct the body. That is precedented and prose-only, frontmatter untouched; check-changeset-overwrite.mjs will report the correction as its own case 2 ("correcting a declaration on purpose … legitimate"), which is the intended shape — one gate asks for the read, the other records the write.

Not covered, stated so nobody reads this as more: a born-false claim that spells no line address at all (objectui#9495 coordinated one by ORDINAL — "a grep finds that member first" — and deciding that means reading what the sentence means), a claim spelled as a symbol or a package rather than a backticked file name, and a file named ambiguously.

Compared the checked-out tree with edbcf1e7a (merge-base with origin/main): 7 file(s) changed outside .changeset/, read against 1203 pending declaration(s) that publish a body (1762 pending in total). · run

@os-try-charles
os-try-charles marked this pull request as ready for review September 19, 2026 05:21
@os-try-charles
os-try-charles added this pull request to the merge queue Sep 19, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 19, 2026
@os-try-charles
os-try-charles added this pull request to the merge queue Sep 19, 2026

Copy link
Copy Markdown
Collaborator Author

⛔ This PR is green and mergeable, and the seat's enqueue route does not work. It needs a hand that can merge it. domain:devx @ objectui execution seat, session session_015h79niBMyoB1xcaQje3uiz, R85 — measured 2026-09-19T06:3xZ.

What is true about this PR

mergeable: true · mergeable_state: clean · CI 34/34 green on head 5585ba55a, deduped by check name to the newest run (33 distinct + the second Governed Surface Queue Guard the draft→ready flip always adds) · 0 review threads open · 0 requested reviewers · Governed Surface Queue Guard reports NOT GOVERNED.

⇒ Nothing about the change is blocking it.

What is broken

I enqueued it at 05:24Z via the only route available to this seat. The confirmation said:

Auto-merge enabled for objectstack-ai/objectui#9996 (method: , enabled at ). …

⚠️ Empty method, empty timestamp. An hour later the PR had not moved, so I ran the control I should have run first:

reader #9996 (subject) #8941 (control, another open PR)
auto_merge null populated (merge_method: merge)

⇒ The field is a working reader on this repo and this token. So #9996's null is a real negative, ⛔ not the instrument's silence. Two further facts agree:

I retried once with MERGE instead of SQUASH. Same empty confirmation, same null. ⛔ That second attempt was my error and could not have worked — this repo reads allow_squash_merge: true, allow_merge_commit: false, allow_rebase_merge: false, so squash was already the only permitted method and the first attempt had it right. #8941's stored merge is a legacy value, ⛔ not evidence of what is permitted today. The method was never the cause.

I have stopped at two attempts and will not make a third. ⛔ I have not approved this PR, ⛔ have not merged it, and ⛔ will not hand-merge my own PR.

The likely mechanism, stated as a hypothesis and ⛔ not as a finding

allow_auto_merge is true on the repository, and the PR is already clean with every required check green — i.e. there is nothing left for auto-merge to wait for. GitHub refuses enablePullRequestAutoMerge in that state, and the wrapper this seat calls appears to report success while swallowing that refusal, which is what produces the empty method and empty enabled at.

⛔ I cannot confirm this: the read-only GET …/issues/*/timeline that would show the refusal is denied to this seat, and GET /branches/main/protection returns 403. ⇒ stated as the shape that fits every measurement above, ⛔ not as something I verified.

What this PR needs

A merge by someone whose route works — the change itself is finished and green. Nothing here is waiting on the diff.

⚠️ And a correction this seat owes about its own record

Item ⑫ in my patrol notes has said for several rounds that the enqueue is merely unverifiable, on the reasoning that earlier rounds "enqueued blind and landed anyway". That reasoning does not survive today's control. Since the auto_merge field demonstrably works, I have no evidence this route ever enqueued anything — those earlier PRs may well have been merged by a maintainer or another seat while this seat recorded the landing as its own enqueue succeeding. ⛔ I am not claiming they were; I am withdrawing the claim that they prove the route works.

⭐ The rule I broke is one I had already written down: never report a zero from a reader you have not proven can find something. The control that settles it — any other open PR's auto_merge — was one call away for the whole hour, and I recorded the null as uninformative instead of testing it.

domain:devx @ objectui execution seat, session session_015h79niBMyoB1xcaQje3uiz


Generated by Claude Code

@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain:devx objectui devx stream: fix lands on .github/, scripts/ or release pipeline — devx lane cross-repo tests tooling

Projects

None yet

2 participants