Skip to content

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

Merged
os-zhuang merged 1 commit into
mainfrom
docs/dogfood-fixes-2338
Jun 26, 2026
Merged

os-zhuang merged 1 commit into
mainfrom
docs/dogfood-fixes-2338

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

What

Two doc inaccuracies in #2338, found by dogfooding (booted app-showcase, exercised the newly-documented features at runtime).

Verified working (no change needed)

  • $search / searchableFields (ADR-0061): $search=technology on showcase_account returned the 4 technology accounts — matching on the industry field, proving it searches the declared searchableFields, not just name.
  • Multi-hop dataset joins (ADR-0071): an inline dataset on showcase_invoice_line with include: ['invoice.account'] + dimension invoice.account.industry returned correctly grouped rows and the expected chained LEFT JOIN ... LEFT JOIN ... SQL.

Fixed

  • page.mdx — responsiveStyles breakpoint keys were wrong. Documented as xs/sm/md/lg/xl/2xl, but ResponsiveStylesSchema uses large / medium / small / xsmall (desktop-first: large = unconditional base, the rest are max-width overrides). The xs..2xl axis is BreakpointName, used for layout columns/visibility/order — a different axis. Confirmed against the served showcase_styling_gallery page metadata (key: large).
  • analytics-datasets.mdx — multi-hop joins need an include declaration. The prior text implied any dotted path joins; in fact joins are derived from the dataset's include and only declared paths are joinable. Now shows include: ['account', 'account.owner'].

Not exercised

access/requiredPermissions (ADR-0066) and controlled_by_parent RLS derivation (ADR-0055) are config-verified (showcase ships them; server boots & accepts them; spec/plugin-security confirmed by audit) but their E2E enforcement wasn't exercised — provisioning a scope-limited test principal needs role-assignment plumbing beyond a quick API pass. Those docs are accurate as written.

Docs-only. Build Docs CI validates MDX.

🤖 Generated with Claude Code

…eys, dataset include)

Browser/dogfood verification of the features documented in #2338 (booted app-showcase,
exercised at runtime) confirmed $search / searchableFields and multi-hop dataset joins
work as documented, but surfaced two doc inaccuracies in #2338 itself:

- page.mdx: responsiveStyles breakpoint keys are `large` / `medium` / `small` / `xsmall`
  (desktop-first — `large` is the unconditional base, the rest are max-width overrides)
  per ResponsiveStylesSchema, NOT the `xs/sm/md/lg/xl/2xl` axis (those are BreakpointName,
  used by layout columns/visibility/order). Verified against the served
  showcase_styling_gallery page metadata (key: `large`).
- analytics-datasets.mdx: multi-hop joins must be DECLARED in the dataset's `include`
  (joins are derived from include; only declared paths are joinable). Verified live: an
  inline dataset on showcase_invoice_line with include:['invoice.account'] + dotted-path
  dimension `invoice.account.industry` returns correctly-joined rows.

Docs-only.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 26, 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 Jun 26, 2026 8:29am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/s labels Jun 26, 2026
@os-zhuang
os-zhuang merged commit 8a5afdf into main Jun 26, 2026
15 checks passed
@os-zhuang
os-zhuang deleted the docs/dogfood-fixes-2338 branch June 26, 2026 08:34

This branch was successfully deployed

1 active deployment
Preview — 33bb1ccc Deployed Jun 26, 2026 by vercel[bot]
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