Skip to content

Commit 30a9e15

Browse files
committed
docs: the synthesized record page is the details and a right column, 动态 first, laid out by one rule
The pages guide and the three QA checklist items that located the stream by the retired timeline column, its switch and the tabbed tier now point at the 动态 panel and its tab (`?related=timeline`). Claude-Session: https://claude.ai/code/session_01Utp6CaA9ZdTcj97mzGtHYt Co-authored-by: Claude <noreply@anthropic.com>
1 parent 1be28f6 commit 30a9e15

2 files changed

Lines changed: 34 additions & 34 deletions

File tree

‎content/docs/ui/pages.mdx‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -180,33 +180,33 @@ replacement.
180180
### The synthesized default
181181

182182
A record page needs no authoring. With no page assigned, the Console synthesizes one from
183-
the object: a header, the highlights strip and a tab strip of **Details**, **Timeline** and
184-
**Related**, plus **Approvals** when the record has approval requests. A relationship whose
185-
child field declares `relatedList: 'primary'` is part of the record's body: its list is a
186-
full-width table inside **Details**, after the first field section, with no tab of its own.
187-
The other related lists are cards in the shared **Related** tab, which an object with
188-
`enable: { files: true }` closes with its attachments. **Timeline** is one stream: the
189-
discussion composer on top, then the discussion, the activity and, with
190-
`enable: { trackHistory: true }`, the record's field changes, filtered by All / Activity /
191-
Discussion / Changes; there is no separate History tab. Moving a child table into the
192-
record's body is therefore a one-word change on the relationship field, not a
193-
page-authoring task, and `relatedList: false` leaves a child off the page.
194-
195-
The Console lays the page out by the width of the surface it occupies (the drawer, the
196-
split pane or the full page), never by the viewport. From 1280 px the tabs become three
197-
columns: details, the timeline stream and the
198-
related lists as cards with Approvals, Attachments and the created/updated line. From
199-
1024 px the related column folds into a rail behind a **Related (N)** toggle. Below that, and
200-
always in a drawer or split pane, the tab strip is drawn. `?tab=` selects a tab in the strip.
201-
202-
In the column tiers the related column loads in steps, and the details column never waits for
203-
it. The page asks every card's count in one request set, sent beside the record read, and the
204-
cards show placeholders until those counts land. A card counted at 0 is its title row alone
205-
and reads no rows. A card above 0 reads its first three rows once it scrolls into view, asking
206-
only for the record's name field and one status or date field. When the timeline column is
207-
switched off, its **Activity** card in the related column stays closed, and reads nothing, until
208-
it is opened. In a drawer, the record that **↑** / **↓** would show next has its related counts
209-
read ahead.
183+
the object: a header, the highlights strip, the record's **details**, and a right column of
184+
panels: **动态** (Activity) first, then the related lists, **Approvals** when the record has
185+
approval requests, and the attachments of an object with `enable: { files: true }`. A
186+
relationship whose child field declares `relatedList: 'primary'` is part of the record's body:
187+
its list is a full-width table in the details, after the first field section, with no panel of
188+
its own. **动态** is one stream: the discussion, the activity and, with
189+
`enable: { trackHistory: true }`, the record's field changes; there is no separate History tab.
190+
Its panel shows a one-line composer and the newest entries, and its header opens the whole
191+
stream (`?related=timeline`), filtered by All / Activity / Discussion / Changes. A related
192+
panel's header opens that list's whole table the same way (`?related=<object>.<field>`).
193+
Moving a child table into the record's body is therefore a one-word change on the
194+
relationship field, not a page-authoring task, and `relatedList: false` leaves a child off the
195+
page.
196+
197+
The Console lays the page out by the width of the surface it occupies (the full page, the split
198+
pane or the drawer), never by the viewport, and by one rule. From 760 px the details sit beside
199+
the right column, 320 px wide; from 1120 px the right column is 380 px and a details section
200+
takes up to three field columns. Below 760 px (the split pane, a phone) the page is one column:
201+
the details, then the right column's panels in their order. The **⊟** switch at the end of the
202+
record header's actions (`⌘⇧,`) hides the right column for the reader, per object.
203+
204+
The related panels load in steps, and the details never wait for them. The page asks every
205+
panel's count in one request set, sent beside the record read, and the panels show
206+
placeholders until those counts land. A panel counted at 0 reads no rows, and two or more of
207+
them fold into one line. A panel above 0 reads its first three rows once it scrolls into view,
208+
asking only for the record's name field and one status or date field. In a drawer, the record
209+
that **↑** / **↓** would show next has its related counts read ahead.
210210

211211
### Slotted pages
212212

@@ -219,12 +219,12 @@ synthesizer fills in the rest. A slotted page authors `slots`, not `regions`:
219219
| `actions` | The action bar (`record:quick_actions`) |
220220
| `alerts` | The alert banners above the body |
221221
| `highlights` | The highlights strip |
222-
| `details` | The body of the Details tab; the other tabs stay synthesized |
222+
| `details` | The record's details; the rest of the page stays synthesized |
223223
| `discussion` | The discussion panel |
224224

225225
Each slot takes one component or an array of them, and replaces its part whole: there is no
226-
deep merge. There is no `tabs` slot: the tab strip is composed from the object's fields and
227-
relationship flags. To change which related lists appear or their order, set `relatedList` /
226+
deep merge. There is no `tabs` slot: the page's panels are composed from the object's fields
227+
and relationship flags. To change which related lists appear or their order, set `relatedList` /
228228
`relatedList: 'primary'` on the child's reference field; a page that needs its own strip is
229229
`kind: 'full'`, drawn as authored. `slots.tabs`, `slots.related` and `slots.relatedLists` are
230230
refused by name, and `os migrate meta --from 17` drops a stored `slots.tabs`.

‎docs/qa/platform-checklist/areas/records-forms.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@
213213
"capture the create request/response (expect POST /api/v1/data/showcase_account). The payload also carries the select defaults of fields the step leaves untouched — sales_region:'amer' (its AMER option is default:true, examples/app-showcase/src/data/objects/account.object.ts) — so expect that key in the body you diff (QA run #24556)",
214214
"re-read server-side: GET /api/v1/data/showcase_account?$filter=[[\"name\",\"=\",\"os-qa-<runid>\"]] — field-by-field vs the submitted payload",
215215
"open the record detail; edit exactly one field (annual_revenue); submit it (an edit form's button reads 'Update'); capture the PATCH /api/v1/data/showcase_account/<id>; re-read the full row via GET /api/v1/data/showcase_account/<id>",
216-
"read the record's field-change history on the record page's timeline stream, under its Changes chip (变更). Record page v3 draws no tab named History at any width (#27055). Where the stream sits depends on the record view's width (ui/packages/plugin-detail/src/synth/recordPageColumns.ts#recordPageTierFor), the window minus the console sidebar: at 760 px and wider it is resident (the Timeline column, or, while the reader's timeline switch is off, the Activity card at the foot of the related column); narrower, it is the Timeline tab. A 1440×900 window is a column tier whatever the sidebar does. Screenshot first, then read the change lines",
216+
"read the record's field-change history on the record page's timeline stream, under its Changes chip (变更). Record page v3 draws no tab named History at any width (#27055). The stream's whole face, with its chips, is the 动态 (Activity) tab: open it from the header of the 动态 panel, the first panel of the record page's right column (below the details in one column under 760 px, ui/packages/plugin-detail/src/synth/recordPageColumns.ts#recordPageTierFor), or by ?related=timeline (#27524). The panel itself shows only the newest lines, with no chips. Screenshot first, then read the change lines",
217217
"clone the record: POST /api/v1/data/showcase_account/<id>/clone (optionally with {overrides:{name:'os-qa-<runid>-clone'}}); capture the 201 result (new id ≠ source, sourceId, record); re-read the clone via GET /api/v1/data/showcase_account/<new id>",
218218
"RLS probe on clone: as a persona WITHOUT read on the source row (a permission-zoo persona, or a non-owner under owner-RLS), POST the same clone route and capture the refusal — expect 404 RECORD_NOT_FOUND, never a silent duplicate (record blocked(fixture) if no non-reading persona is bound on this boot)",
219219
"delete via the row/detail action; confirm the dialog; re-read via the filtered GET. ⚠️ If clause 7's recipe gave the member an own-row invoice pointing at THIS account, the delete answers 409 DELETE_RESTRICTED: the invoice's account lookup is required, and the engine turns a required set_null into restrict (packages/objectql/src/engine.ts). Point that invoice at a seeded account instead (the recipe's step 5 says so)",
@@ -3725,7 +3725,7 @@
37253725
"steps": [
37263726
"open a record; run the packaged undoable action (fixtures.requires[0]) on it; confirm the success toast shows an Undo button. An inline edit offers none by design",
37273727
"click Undo (or press Ctrl+Z); capture the resulting update; re-read the record over the API and confirm the prior value is restored",
3728-
"read the record's field-change history on the record page's timeline stream, under its Changes chip (变更). Record page v3 draws no tab named History at any width (#27055). Where the stream sits depends on the record view's width (ui/packages/plugin-detail/src/synth/recordPageColumns.ts#recordPageTierFor), the window minus the console sidebar: at 760 px and wider it is resident (the Timeline column, or, while the reader's timeline switch is off, the Activity card at the foot of the related column); narrower, it is the Timeline tab. A 1440×900 window is a column tier whatever the sidebar does. Also read sys_audit_log for the record over the API, and confirm a revert entry was added (a forward write, not a silent rollback)",
3728+
"read the record's field-change history on the record page's timeline stream, under its Changes chip (变更). Record page v3 draws no tab named History at any width (#27055). The stream's whole face, with its chips, is the 动态 (Activity) tab: open it from the header of the 动态 panel, the first panel of the record page's right column (below the details in one column under 760 px, ui/packages/plugin-detail/src/synth/recordPageColumns.ts#recordPageTierFor), or by ?related=timeline (#27524). The panel itself shows only the newest lines, with no chips. Also read sys_audit_log for the record over the API, and confirm a revert entry was added (a forward write, not a silent rollback)",
37293729
"press Ctrl+Shift+Z (redo); confirm the edited value is restored",
37303730
"CONCURRENT-CLOBBER probe: in session A make the undoable edit; in session B change the SAME field and save; back in A, click Undo",
37313731
"observe and FLAG whether A's undo carries an OCC guard or silently overwrites B's value"
@@ -5171,7 +5171,7 @@
51715171
"boot the showcase on its own port and DB; sign in as admin; open a seeded account record",
51725172
"edit the TRACKED select `industry` (e.g. Technology → Finance); save; read the record's sys_activity rows over the API and open the timeline",
51735173
"edit an UNTRACKED field (e.g. website) alone; save; re-read sys_activity for the record",
5174-
"record the network log from page load, open the account record and select its timeline stream's Changes chip (变更). Record page v3 has no History tab at any width (#27055). Where the stream sits depends on the record view's width (ui/packages/plugin-detail/src/synth/recordPageColumns.ts#recordPageTierFor), which is the window minus the console sidebar. At 760 px and wider it is resident: the Timeline column, or, while the reader's timeline switch is off, the Activity card at the foot of the related column. The switch is off by default for an object that is not worked, and showcase_account is not one (ui/packages/plugin-detail/src/synth/recordPageColumns.ts#recordTimelineDefaultReason answers null). Narrower, it is the Timeline tab. Measured on this item's re-point: a 1440×900 window gave 1184 px (sidebar expanded) and a 1000×800 window 952 px (sidebar as its icon rail), both columns with no tab strip; only a 700×800 window drew the tabs (Details / Related / Timeline). Then open a seeded task's detail and read the network log again",
5174+
"record the network log from page load, open the account record and select its timeline stream's Changes chip (变更). Record page v3 has no History tab at any width (#27055). The chips are on the stream's whole face, the 动态 (Activity) tab: open it from the header of the 动态 panel, the first panel of the record page's right column at every width (below the details in one column under 760 px, ui/packages/plugin-detail/src/synth/recordPageColumns.ts#recordPageTierFor), or by ?related=timeline (#27524). No width draws a tab strip on the synthesized page. Then open a seeded task's detail and read the network log again",
51755175
"GET /api/v1/auth/me/permissions and compare apiOperations for showcase_account vs showcase_task"
51765176
],
51775177
"acceptance": [
@@ -5190,7 +5190,7 @@
51905190
{
51915191
"clause": "the record page's sys_audit_log field-change history gates on OBJECT-level enable.trackHistory, both ways: the account detail (flag true) reads sys_audit_log and its timeline stream's Changes chip lists the tracked edits as old → new lines with display values; the task detail (no enable block — per-field flags alone do not summon it) makes NO sys_audit_log read",
51925192
"oracle": "network",
5193-
"verify": "the network log after settle: one sys_audit_log read for the account record (at page load in a column tier; in the tabbed tier when the Timeline tab opens, or at load under ?tab=timeline) and none for the task; screenshot the account's Changes chip showing the industry edit. Gating ruled at ui/packages/app-shell/src/views/RecordDetailView.tsx (historyEnabled: enable.trackHistory explicitly true, sys_audit_log registered, the viewed object not sys_audit_log itself; and the read serves only the synthesized page's stream, never an assigned page); the read's rows reach the stream through RecordFieldChangesContext as field_change items (ui/packages/plugin-detail/src/recordTimelineStream.ts#auditEntriesToFeedItems). The task half is over-determined (knownGaps): record which gate the verdict rests on. ⛔ An empty Changes chip is never an absence oracle: the chip also lists the stream's sys_activity created/updated rows (ACTIVITY_TYPE_TO_FEED_TYPE maps both to field_change). Measured on a seeded account, the chip showed a sys_activity 'Updated Account …' row beside the audit read. ⛔ Nor is a History tab: record page v3 removed it at every width (#27055; buildDefaultPageSchema.test.ts asserts 'no Activity or History tab'), so looking for one fails a working product (QA run #27438)",
5193+
"verify": "the network log after settle: one sys_audit_log read for the account record (at page load, at every width: the 动态 panel is on screen at open since #27524) and none for the task; screenshot the account's Changes chip showing the industry edit. Gating ruled at ui/packages/app-shell/src/views/RecordDetailView.tsx (historyEnabled: enable.trackHistory explicitly true, sys_audit_log registered, the viewed object not sys_audit_log itself; and the read serves only the synthesized page's stream, never an assigned page); the read's rows reach the stream through RecordFieldChangesContext as field_change items (ui/packages/plugin-detail/src/recordTimelineStream.ts#auditEntriesToFeedItems). The task half is over-determined (knownGaps): record which gate the verdict rests on. ⛔ An empty Changes chip is never an absence oracle: the chip also lists the stream's sys_activity created/updated rows (ACTIVITY_TYPE_TO_FEED_TYPE maps both to field_change). Measured on a seeded account, the chip showed a sys_activity 'Updated Account …' row beside the audit read. ⛔ Nor is a History tab: record page v3 removed it at every width (#27055; buildDefaultPageSchema.test.ts asserts 'no Activity or History tab'), so looking for one fails a working product (QA run #27438)",
51945194
"evidence": "the two network logs + the account's Changes screenshot"
51955195
},
51965196
{

0 commit comments

Comments
 (0)