Uh oh!
There was an error while loading. Please reload this page.
docs(spec): retarget PageSchema source TSDoc to canonical kind==='html' - #10536
Conversation
The TSDoc block above `source` keyed the JSX-source-of-truth rule (ADR-0080) to the deprecated `kind === 'jsx'` alias, while source's own `.describe()` and kind's own `.describe()` both state the canonical value is 'html' with 'jsx' a deprecated alias. The TSDoc is the in-editor hover text, so it was teaching authors the legacy spelling. Retarget the TSDoc to the canonical value, matching the describe's own phrasing. One-line change; describe strings, schema, and superRefine untouched. Fixes#10437 Co-Authored-By: Claude Code <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016gcKVsiywU9CcS96S5t9qD
📓 Docs Drift CheckThis PR changes 1 package(s): 1 hand-written doc(s) NAME something this change touched and may need an implementation-accuracy re-verification:
What this run could not see
Coarse fallback — 122 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): Which tree this was computed onThis run read A worktree cut from an older # while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 8248786622dea7445cac47ebf4fe1f687042e0f0 && git checkout 8248786622dea7445cac47ebf4fe1f687042e0f0
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 359f5956d7910aed7ae9f8fccc9fbb988b3e4882 f94c13b56c6b015a01866c622f64d4cc128d26f0 && git checkout -B drift-repro 359f5956d7910aed7ae9f8fccc9fbb988b3e4882 && git merge --no-ff f94c13b56c6b015a01866c622f64d4cc128d26f0
node scripts/docs-audit/affected-docs.mjs --json 359f5956d7910aed7ae9f8fccc9fbb988b3e4882
|
Uh oh!
There was an error while loading. Please reload this page.
Fixes#10437
What
packages/spec/src/ui/page.zod.ts, the TSDoc block abovesource, keyed theJSX-source-of-truth rule (ADR-0080) to the deprecated
kind === 'jsx'alias:source's own.describe()(the string that ships tocontent/docs/references/ui/page.mdx) andkind's own.describe()both statethe canonical value is
'html', with'jsx'a deprecated alias. The TSDoc isthe in-editor hover text for the property, so it was teaching authors the
legacy spelling.
Fix
One-line retarget of the TSDoc to the canonical value, matching the describe's
own phrasing:
Nothing else in the block, the
.describe()strings, the schema, or thesuperRefinechanged.Scope verification
mainafter PR docs(spec): name the real per-tier styling primitive on PageSchema kind/source #10436 (same file) merged; re-found the TSDocblock at the same line (565) on the merged ref — the card's premise held.
content/docs/references/ui/page.mdx(grep, no match) — matches the card'sclaim that this block does not project into the generated reference, so no
check:generated/docs regen is expected from this change.Verification (at
f94c13b56)pnpm --filter @objectstack/spec typecheck— passpnpm --filter @objectstack/spec test -- --maxWorkers=2— 416 files / 11092 tests passedpnpm --filter @objectstack/spec run check:generated— all 14 generated artifacts up to date (check:docsclean — confirms nopage.mdxregen, per the card's own claim)node scripts/pm/dispatch-gates.mjs(no paths, at final commit) — local gate list unchanged from dispatch time; all matched:check:cross-package-test-inputs,check:doc-formula-expressions,check:empty-state,check:liveness,check:merge-driver,check:slot-lookup,check:spec-parsed-alias,check:strictness-ledger,check:type-source-resolution,check:variant-docs,check-cross-package-test-inputs.mjs,check-affected-docs.mjs— all passcheck:nul-bytes— cleanscripts/check-dev-prereqs.mjs(repo-wide "workspace built" precondition, all 67 packages) not run locally — out of scope for a one-line TSDoc change under directed local-verification scope; CI builds the full farm regardless.Changeset
Comment-only TSDoc change (in-editor hover text), no schema/describe/behavior
change — no user-facing published change. Routed via the
skip-changesetlabel per the #10168 JSDoc precedent instead of a changeset file.
Generated by Claude Code