docs: fix responsiveStyles keys + dataset include (found dogfooding #2338)#2340
Merged
Conversation
…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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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=technologyonshowcase_accountreturned the 4 technology accounts — matching on theindustryfield, proving it searches the declaredsearchableFields, not just name.showcase_invoice_linewithinclude: ['invoice.account']+ dimensioninvoice.account.industryreturned correctly grouped rows and the expected chainedLEFT JOIN ... LEFT JOIN ...SQL.Fixed
page.mdx—responsiveStylesbreakpoint keys were wrong. Documented asxs/sm/md/lg/xl/2xl, butResponsiveStylesSchemauseslarge/medium/small/xsmall(desktop-first:large= unconditional base, the rest aremax-widthoverrides). Thexs..2xlaxis isBreakpointName, used for layout columns/visibility/order — a different axis. Confirmed against the servedshowcase_styling_gallerypage metadata (key:large).analytics-datasets.mdx— multi-hop joins need anincludedeclaration. The prior text implied any dotted path joins; in fact joins are derived from the dataset'sincludeand only declared paths are joinable. Now showsinclude: ['account', 'account.owner'].Not exercised
access/requiredPermissions(ADR-0066) andcontrolled_by_parentRLS 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