Skip to content

docs: fix responsiveStyles keys + dataset include (found dogfooding #2338) #2340

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
Jun 26, 2026
Merged

docs: fix responsiveStyles keys + dataset include (found dogfooding #2338) #2340

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
11 changes: 7 additions & 4 deletions content/docs/guides/analytics-datasets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,13 @@ capability the inline single-object query could never reach:
// → revenue by account.region, joined + RLS-enforced per object.
```

Joins follow **dotted relationship paths** and may traverse **multiple to-one hops**
(ADR-0071) — e.g. `account.owner.region` walks the chain order → account → owner →
region. The path is capped at **3 join hops (4 objects)** and is **to-one only**;
to-many traversal is rejected (aggregate the many-side as its own measure instead).
Joins are **derived from the dataset's `include` declarations**: list the relationship
paths to join (`include: ['account', 'account.owner']`), and dimensions/measures then
reference fields along them by **dotted path** (`account.owner.region`). Only declared
paths are joinable. Paths may chain **multiple to-one hops** (ADR-0071 — declaring
`account.owner` implicitly includes `account`), are capped at **3 join hops (4 objects)**,
and are **to-one only**; to-many traversal is rejected (aggregate the many-side as its
own measure instead).

## How it runs

Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/metadata/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Components are the building blocks placed inside regions.
| `events` | `Record<string, string>` | optional | Event handlers (action expressions) |
| `style` | `object` | optional | CSS styles |
| `className` | `string` | optional | CSS class names |
| `responsiveStyles` | `object` | optional | **Preferred** SDUI styling channel (ADR-0065): per-breakpoint scoped CSS-property maps keyed by `xs`/`sm`/`md`/`lg`/`xl`/`2xl`, compiled to id-scoped CSS at render. Prefer design tokens, e.g. `{ base: { padding: 'var(--space-6)' }, md: { padding: 'var(--space-8)' } }`. Use over ad-hoc `style`/`className` for metadata-authored pages. |
| `responsiveStyles` | `object` | optional | **Preferred** SDUI styling channel (ADR-0065): **desktop-first** per-breakpoint scoped style maps, compiled to id-scoped CSS at render. Keys are `large` (the unconditional base), then `medium` / `small` / `xsmall` as `max-width` overrides. Prefer design tokens, e.g. `{ large: { padding: 'var(--space-8)' }, small: { padding: 'var(--space-4)' } }`. Use over ad-hoc `style` / `className` for metadata-authored pages. |
| `visibility` | `string` | optional | Visibility predicate (CEL expression) |

The `type` field is a union of the standard `PageComponentType` enum and any custom string. The standard (namespaced) component types include:
Expand Down