Skip to content

docs(spec): scrub stale compactLayout teachings + orphaned defaultDetailForm JSDoc (ADR-0085 remnants) #2530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Jul 3, 2026
Merged

docs(spec): scrub stale compactLayout teachings + orphaned defaultDetailForm JSDoc (ADR-0085 remnants) #2530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .changeset/adr-0085-code-doc-remnants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
'@objectstack/spec': patch
---

Clean up two stale code-side doc remnants found during the ADR-0085 docs sweep (#2529):

- `RecordDetailsProps` (ui/component.zod.ts) `layout`/`fields` descriptions taught the
deprecated `compactLayout` name — now teach the ADR-0085 canonical `highlightFields`
(`compactLayout` remains a supported alias). Regenerated
`skills/objectstack-ui/{contracts/react-blocks.contract.json,references/react-blocks.md}`.
- Removed an orphaned JSDoc block in data/object.zod.ts describing `defaultDetailForm`,
a prop that was never implemented and was removed from the spec in #2402.

Doc-text only; no schema shape or behavior change.
11 changes: 0 additions & 11 deletions packages/spec/src/data/object.zod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,17 +650,6 @@ const ObjectSchemaBase = z.object({
listViews: z.record(z.string(), ListViewSchema).optional().describe('Built-in named list views (segmented tabs) shipped with the object schema'),

/**
* Default FormView used when displaying a single record's detail page.
*
* Matches the named FormView under the same object's `ViewSchema.formViews`.
* When unset, the runtime falls back to the unnamed `form` view, then to
* an auto-generated layout. This is the Airtable-style "Interface form"
* binding — every record-detail screen renders through a FormView, so the
* same metadata drives both the public collection form and the operator's
* edit panel.
*/

/**
* Search Engine Config
*/
searchableFields: z.array(z.string()).optional().describe('Fields the `$search` query matches against (ADR-0061). Canonical default for the record picker, list quick-search and global search; views may narrow it. When unset, search auto-defaults to the name/title field plus short-text fields.'),
Expand Down
4 changes: 2 additions & 2 deletions packages/spec/src/ui/component.zod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ export const PageCardProps = z.object({

export const RecordDetailsProps = z.object({
columns: z.enum(['1', '2', '3', '4']).default('2').describe('Number of columns for field layout (1-4)'),
layout: z.enum(['auto', 'custom']).default('auto').describe('Layout mode: auto uses object compactLayout, custom uses explicit sections'),
layout: z.enum(['auto', 'custom']).default('auto').describe('Layout mode: auto uses object highlightFields, custom uses explicit sections'),
sections: z.array(z.string()).optional().describe('Section IDs to show (required when layout is "custom")'),
fields: z.array(z.string()).optional().describe('Explicit field list to display (optional, overrides compactLayout)'),
fields: z.array(z.string()).optional().describe('Explicit field list to display (optional, overrides highlightFields)'),
/** ARIA accessibility */
aria: AriaPropsSchema.optional().describe('ARIA accessibility attributes'),
});
Expand Down
4 changes: 2 additions & 2 deletions skills/objectstack-ui/contracts/react-blocks.contract.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@
"type": "'auto' | 'custom'",
"kind": "data",
"required": true,
"description": "Layout mode: auto uses object compactLayout, custom uses explicit sections"
"description": "Layout mode: auto uses object highlightFields, custom uses explicit sections"
},
{
"name": "sections",
Expand All @@ -410,7 +410,7 @@
"type": "string[]",
"kind": "data",
"required": false,
"description": "Explicit field list to display (optional, overrides compactLayout)"
"description": "Explicit field list to display (optional, overrides highlightFields)"
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions skills/objectstack-ui/references/react-blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,9 @@ Field-detail panel for the bound record. Config props from the spec RecordDetail
| `objectName` | `string` | binding | | The record’s object. |
| `recordId` | `string \| number` | controlled | | The record to show. |
| `columns` | `'1' \| '2' \| '3' \| '4'` | data | ✓ | Number of columns for field layout (1-4) |
| `layout` | `'auto' \| 'custom'` | data | ✓ | Layout mode: auto uses object compactLayout, custom uses explicit sections |
| `layout` | `'auto' \| 'custom'` | data | ✓ | Layout mode: auto uses object highlightFields, custom uses explicit sections |
| `sections` | `string[]` | data | | Section IDs to show (required when layout is "custom") |
| `fields` | `string[]` | data | | Explicit field list to display (optional, overrides compactLayout) |
| `fields` | `string[]` | data | | Explicit field list to display (optional, overrides highlightFields) |

## `<RecordHighlights>` — `record:highlights`

Expand Down