Uh oh!
There was an error while loading. Please reload this page.
docs: fix Console Template phantom tabs on record:details - #8438
Merged
Conversation
`layout-dsl.mdx`'s Console Template authored `tabs: [details, related, activity]` under `record:details.properties` — a key `ui/RecordDetailsProps` (strictObject) does not declare. Rewritten to the schema-accepted shape: a `page:tabs` component whose three `items` each carry the appropriate child (`record:details`, `record:related_list`, `record:activity`), matching the section's own "Visual Layout" ASCII diagram (Details/Related/Activity tabs, Subject/Priority/Status fields). Measured via `validateComponentProps` (packages/lint) against a fixture reproducing the doc's example: the old shape is flagged `component-props-unknown-key`, severity `warning` (advisory only — the rule's `ComponentPropsSeverity` type is a single `'warning'` literal, never `'error'`) — so this was not rejected at publish, it was silently forwarded to objectui's renderer and ignored there. The new shape produces zero findings from the same rule. Fixes#8403 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jqe56GnYFddggeAyfkZFVz
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
qq9340100
marked this pull request as ready for review
August 13, 2026 13:28
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes#8403
What was wrong
content/docs/protocol/objectui/layout-dsl.mdx's Console Template (~line 142) authored:ui/RecordDetailsProps(packages/spec/src/ui/component.zod.ts:693,strictObject) declaresaria,columns,fields,hideFields,inlineEdit,sections,showHeader(+ retiredlayout) — notabs.Measurement (per triage's binding first step)
Ran
validateComponentProps(packages/lint) against a fixture reproducing the doc's exact example:{ "severity": "warning", "rule": "component-props-unknown-key", "where": "page \"console_probe\" · record:details", "path": "pages[0].regions[0].components[0].properties.tabs", "message": "`tabs` is not a prop `record:details` declares ..." }ComponentPropsSeverity(validate-component-props.ts:113) is a single'warning'literal today — never'error'— so this is not rejected at publish; it is an advisory lint finding. At runtime, objectui'sSchemaRendererspreads unknownpropertieskeys onto the component and the renderer ignores what it doesn't read, so the doc's own "Visual Layout" ASCII diagram (a Details/Related/Activity tab strip) was never actually produced by the example as written — silently forwarded, not rejected.Fix
Rewrote the example to the schema-accepted shape the card names: a
page:tabscomponent (ui/PageTabsProps) whose threeitemseach carry the appropriate child component —record:details(Details),record:related_list(Related),record:activity(Activity) — which matches the section's own ASCII "Visual Layout" (Det/Related/Activity strip, Subject/Priority/Status fields) far better than the original ever did.Re-ran the same measurement against the new shape: zero findings.
Did not widen
RecordDetailsProps— that would be adomain:speccontract change out of this card's lane (ruling in the dispatch prompt).Same-pass check (in scope per triage item 3)
Grepped all of
content/docs/**/*.mdxforrecord:detailsand fortype: record:details: only one occurrence repo-wide (this file, this line).content/docs/references/ui/component.mdxandcontent/docs/references/ui/page.mdxare generated reference tables and declare notabsexample;content/docs/ui/pages.mdx'srecord:detailsusage already uses the validfieldskey. No other findings to file.Scope
Declared file surface:
content/docs/protocol/objectui/layout-dsl.mdxonly — diff is exactly that one file, 19 insertions / 2 deletions, confined to the one code block. #8303 (PR #8402) and #8251 (PR #8301)'s sections on this same page are untouched.Gates (local)
pnpm check:docs-audit-scope— passpnpm check:quick-reference-counts— passpnpm check:role-word— passpnpm --filter @objectstack/lint run check:doc-formula-expressions(deps built first:pnpm --filter '@objectstack/lint^...' build) — pass, 24/24 self-test casespnpm check:nul-bytes— passRe-derived against the actual changed path via
node scripts/pm/dispatch-gates.mjs content/docs/protocol/objectui/layout-dsl.mdx: surfaces exactly the same fourcontent/docs-scoped families already run above (plus the standingcheck:nul-bytesany-edit convention). No additional family implicated.Docs-only change — no runtime/behavior surface —
skip-changesetlabel applied.Generated by Claude Code