Skip to content

Commit 1e406a5

Browse files
os-zhuangclaude
andauthored
docs: the compactLayout alias is retired, not accepted (#2536 follow-up) (#2542)
Two guides still taught 'formerly compactLayout, accepted as an alias' — true during the ADR-0085 deprecation window, false since #2539: create() now rejects the old spelling. AI authors copy docs verbatim, so a doc teaching a retired-but-'accepted' key is a 422 generator. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 6a9397e commit 1e406a5

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

content/docs/guides/data-modeling.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export const MyObject = ObjectSchema.create({
6767
| `icon` | string | Icon identifier | `'building'` |
6868
| `description` | string | Help text | `'Companies...'` |
6969
| `titleFormat` | string | Record title template (`{{record.field}}` interpolation) | `'{{record.name}} - {{record.id}}'` |
70-
| `highlightFields` | string[] | Most-important fields, in priority order (default columns, cards, previews, detail highlight strip; ADR-0085 — formerly `compactLayout`, still accepted as an alias) | `['name', 'status']` |
70+
| `highlightFields` | string[] | Most-important fields, in priority order (default columns, cards, previews, detail highlight strip; ADR-0085 — formerly `compactLayout`; the old spelling was retired and is now rejected) | `['name', 'status']` |
7171

7272
### Enable Features
7373

content/docs/guides/metadata/object.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export const Account = ObjectSchema.create({
6868
| :--- | :--- | :--- | :--- |
6969
| `displayNameField` | `string` | optional | Field used as record display name (defaults to `'name'`) |
7070
| `titleFormat` | `string` | optional | Title expression (e.g. `'{name} - {code}'`) |
71-
| `highlightFields` | `string[]` | optional | Most-important fields in priority order — default list columns, cards, previews, detail highlight strip (ADR-0085; formerly `compactLayout`, accepted as an alias) |
71+
| `highlightFields` | `string[]` | optional | Most-important fields in priority order — default list columns, cards, previews, detail highlight strip (ADR-0085; formerly `compactLayout` — the old spelling was retired and is now rejected) |
7272
| `stageField` | `string \| false` | optional | Linear lifecycle field; `false` declares the status field non-linear and suppresses stage heuristics (ADR-0085) |
7373
| `recordName` | `object` | optional | Record name auto-generation config |
7474

0 commit comments

Comments
 (0)