Skip to content

docs: retire legacy UI-hint keys (ADR-0085 semantic roles)#2529

Merged
os-zhuang merged 1 commit into
mainfrom
docs/adr-0085-retire-legacy-hint-keys
Jul 3, 2026
Merged

docs: retire legacy UI-hint keys (ADR-0085 semantic roles)#2529
os-zhuang merged 1 commit into
mainfrom
docs/adr-0085-retire-legacy-hint-keys

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Docs-only sweep for teachings of the object UI-hint keys that ADR-0085 removed or renamed, rewritten to the current semantic-role protocol (nameField / highlightFields / stageField / fieldGroups + Field.group; per-page customization via an assigned Page). Executes the "Docs and skills … are updated in the same change series" item from ADR-0085 §Execution.

Files touched

  • content/docs/guides/data-modeling.mdx — the Field Groups example and the ObjectFieldGroup property table taught the removed group-level visibleOn and the deprecated defaultExpanded flag. Now teach the collapse enum ('none' | 'expanded' | 'collapsed', with a note that defaultExpanded is a deprecated alias) and point per-page needs at an assigned Page.
  • content/docs/guides/public-forms.mdx — §10 taught ObjectSchema.defaultDetailForm and a views.formViews / views.form resolution chain. defaultDetailForm was never implemented and was removed from spec in the dead-props batch (feat(spec): remove first batch of dead metadata props (#2377, A2) #2402); object-level views.* hints were retired by ADR-0085. The section now explains that record detail derives from the semantic roles, with an assigned Page schema as the supported per-page path. Frontmatter description updated to match.
  • skills/objectstack-data/SKILL.md — fieldGroups example modernized (collapse: 'collapsed' instead of defaultExpanded: false; removed the group visibleOn line) and the group bullets now teach the collapse enum + assigned-Page guidance.
  • skills/objectstack-ui/SKILL.md — removed the detail.relatedLayout ('stack' | 'tabs') teaching (the whole object-level detail: {...} block is gone). Now teaches: single Related tab is the built-in layout; first-class child-table navigation = a custom record Page with record:related_list blocks; relationship-level refinements (relatedList: false, relatedListTitle / relatedListColumns) remain.
  • skills/objectstack-formula/SKILL.md — dropped the ObjectFieldGroup | visibleOn row from the CEL-surface inventory (key removed per ADR-0085 / ADR-0049 enforce-or-remove).

Deliberately untouched

  • docs/adr/** — historical records, never rewritten.
  • CHANGELOGs / .changeset/** — historical.
  • docs/audits/2026-06-objectschema-property-liveness.md (and the dead-surface disposition plan) — point-in-time audit snapshots; they document the legacy keys, they don't teach them.
  • content/docs/references/** (ui/component.mdx, ui/view.mdx, studio/object-designer.mdx) — auto-generated from spec (build-docs.ts); their defaultExpanded / defaultExpandedDepth hits belong to unrelated Studio-designer / tree-view config schemas, not ObjectFieldGroup.
  • skills/objectstack-ui/references/react-blocks.md — generated from packages/spec/src/ui/react-blocks.ts; its two stale compactLayout prop-description mentions live in that source file (code, out of scope for a docs sweep — noted as follow-up).

Verification

  • pnpm check:doc-authoring — clean (171 files, no bare metadata literals).
  • pnpm docs:build — green. (The build locally regenerated content/docs/references/** with unrelated pre-existing drift vs. current spec; that churn was reverted, not committed.)
  • Re-grep of the full legacy-key term list over docs/**, content/**, skills/**, packages/*/README.md, examples/** — remaining hits are only ADRs, audits, changelogs, generated references, and the new "deprecated alias" notes themselves.

🤖 Generated with Claude Code

Sweep hand-written docs and skills for teachings of the object UI-hint
keys ADR-0085 removed/renamed, and rewrite them to the current
semantic-role protocol (nameField / highlightFields / stageField /
fieldGroups + Field.group, per-page customization via an assigned Page):

- content/docs/guides/data-modeling.mdx: fieldGroups example + property
  table taught the removed ObjectFieldGroup.visibleOn and the deprecated
  defaultExpanded flag; now teach the collapse enum
  ('none'|'expanded'|'collapsed') and drop group-level visibleOn.
- content/docs/guides/public-forms.mdx: section 10 taught the removed
  (never-implemented) ObjectSchema.defaultDetailForm binding and the
  retired views.formViews/views.form resolution chain; rewritten to
  explain record detail is derived from the semantic roles, with an
  assigned Page as the per-page customization path. Frontmatter
  description updated accordingly.
- skills/objectstack-data/SKILL.md: fieldGroups example modernized
  (collapse instead of defaultExpanded; group visibleOn removed) and the
  group-property bullet now teaches the collapse enum.
- skills/objectstack-ui/SKILL.md: detail.relatedLayout ('stack'|'tabs')
  teaching removed with the whole detail:{...} block; now teaches the
  default single Related tab + custom record Page (record:related_list)
  for first-class child-table navigation.
- skills/objectstack-formula/SKILL.md: dropped the
  ObjectFieldGroup.visibleOn row from the CEL-surface inventory (the key
  was removed per ADR-0085 / ADR-0049 enforce-or-remove).

ADRs, changelogs/changesets, audits, and auto-generated references
(content/docs/references/**, skills/objectstack-ui/references/
react-blocks.md) are deliberately untouched.

Verified: check:doc-authoring clean; docs:build green.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jul 3, 2026 2:41am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/s labels Jul 3, 2026
@os-zhuang
os-zhuang merged commit e8b78bb into main Jul 3, 2026
15 checks passed
@os-zhuang
os-zhuang deleted the docs/adr-0085-retire-legacy-hint-keys branch July 3, 2026 02:45
os-zhuang added a commit that referenced this pull request Jul 3, 2026
…ailForm JSDoc (ADR-0085 remnants) (#2530)

Follow-up to the ADR-0085 hand-written docs sweep (#2529) — these two remnants
live in code and regenerate into docs:

- RecordDetailsProps layout/fields descriptions taught the deprecated
  compactLayout name; now teach the canonical highlightFields (compactLayout
  remains a supported alias). Regenerated react-blocks contract + reference md.
- Removed an orphaned JSDoc block for defaultDetailForm in object.zod.ts — the
  prop was never implemented and was removed from the spec in #2402.

Doc-text only; no schema shape or behavior change.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot mentioned this pull request Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant