Skip to content

docs: reconcile table chart page with the shipped Style tab and document its gaps - #11451

Open
igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-2720-table-chart-docs-gap-pass
Open

docs: reconcile table chart page with the shipped Style tab and document its gaps#11451
igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-2720-table-chart-docs-gap-pass

Conversation

@igorlukanin

Copy link
Copy Markdown
Member

Summary

  • The table chart page still described a Display tab and a Display as control that the shipped UI doesn't have. Removes the Links and Images subsections — they told the reader to pick display modes that don't exist — and rewrites the section around what does: a Value toggle that composes with a Bars / Sparkline pair, on numeric columns only.
  • Corrects four option rows that the Style tab rework invalidated: the modes are no longer mutually exclusive, Show value is now one shared toggle rather than a per-visualization switch, and sparkline availability depends on the semantic view's time dimensions, not the query's.
  • Documents what shipped but was never written up: pagination (fixed page size, totals pinned across pages), the conditional-formatting operators per data type, the Format scope control, and the fact that alignment is three independent controls whose defaults differ — values follow the column's data type rather than defaulting to left.
  • Reconciles the column-width prose with the control's actual labels (Flex / Fix / Fit), and adds a Sorting section pointing at the querying-data page.

Test plan

  • Every control name, default, and operator verified against the current source rather than the previous prose — which is how the alignment and pagination claims above were caught
  • Rendered locally with mintlify dev: page returns 200, no MDX errors, new sections present and removed content gone
  • Confirmed no page links to the removed #display-tab anchor, and that the #sorting and #conditions targets resolve
  • CI must pass

Screenshot placeholders for the new sections are left unresolved, in the documented form — capture is tracked separately.

@igorlukanin
igorlukanin requested a review from keydunov as a code owner August 2, 2026 10:44
@mintlify

mintlify Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview Aug 2, 2026, 10:45 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude

claude Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 2m 1s —— View job


Review complete — docs-only, no blockers. 1 medium, 2 low posted inline, plus 4 nits below.

Full review
  • Read PR diff
  • Read full rendered page for coherence
  • Verify links/anchors resolve
  • Check Mintlify/docs conventions (docs-mintlify/CLAUDE.md)
  • Post review

Verification I could do

Claim Result
Nothing links to the removed #display-tab ✅ Only inbound anchor link to this page is #cell-menu from docs/data-modeling/dimensions.mdx:511
#sorting target resolves docs/explore-analyze/workbooks/querying-data.mdx:148
#conditions, #pivots, #column-width, #totals ✅ All present in-page
Frontmatter, heading levels, root-relative links, <Note> usage ✅ Conform to docs-mintlify/CLAUDE.md
Removed calculated-fields link orphaned anything ✅ Referenced from three other pages, still live

What I could not verify: every control name, default, and operator in this PR describes the workbook UI, which does not live in this repo. The test plan says these were checked against source — I'm taking that at face value. The Style-tab rework claims (Value composing with Bars/Sparkline, the 50-row page size, the four operator tables) are unfalsifiable from here.

Inline comments

  1. Medium — format: link / format: imageUrl lost their only pointer (line 96). Dropping the Links and Images subsections is correct if the Display as control never shipped, but the capability is real — both are valid dimension formats (CubeValidator.ts:117, documented at reference/data-modeling/dimensions.mdx:271). A reader now leaves this page believing link and image columns aren't supported. One sentence fixes it.
  2. Low — alignment default stated three times (lines 216–222). Table row 42, prose 216, and the callout 220 all say the same thing; docs-mintlify/CLAUDE.md names this pattern specifically.
  3. Low — sparkline option table drifted from its heading (lines 128–138). Four paragraphs, two callouts, and a placeholder now sit between them.

Nits (no action needed)

  • **Text** / **Numbers** / **Dates** / **Booleans** as pseudo-headings (284–319). #### would give each an anchor and put them in the page nav — useful when someone wants to link "which operators do date fields get?"
  • Two screenshot-placeholder styles now coexist. The new ones (70, 134) use the form docs-mintlify/CLAUDE.md documents; the pre-existing ones use the older (hidden — replace this comment with <Frame>…) form. New ones are right; worth normalizing the rest in a follow-up rather than here.
  • "Pixel widths start at 10 and step in tens" (54) reads ambiguously — minimum 10 with a step of 10, or something else? "The minimum is 10 px, and the stepper moves in tens" is unambiguous.
  • `×1` and `px` in code fences (53–54) are UI affordances, not code. Bold would match how every other control on the page is marked up.

What's good

The pagination, conditions, and Format-scope sections are the kind of thing that normally never gets written down. The "Select columns falls back to Source column when you clear everything" detail (329) and the sparkline's one-way dimension removal (120) are both exactly the sort of behavior a reader hits and then can't explain — good catches.

• branch `igor/cub-2720-table-chart-docs-gap-pass`

Display a field as an image by setting **Display as** to **Image**. Configure height and width. To make the image a link, check **Link image** and set the **Link URL**.

The URL must be publicly accessible without authentication.
These controls appear only on numeric columns.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the Links and Images subsections is right if the Display as control never shipped, but it drops the only mention of a capability that does exist — it just lives in the data model rather than the chart UI. format: link and format: imageUrl are valid dimension formats (packages/cubejs-schema-compiler/src/compiler/CubeValidator.ts:117) and are documented at reference/data-modeling/dimensions.mdx:271.

A reader who came to this page to render a column as a link or an image now leaves with "not supported" rather than "set it on the dimension." One sentence closes the gap without reintroducing the wrong prose:

Suggested change
These controls appear only on numeric columns.
These controls appear only on numeric columns.
To render a column as a hyperlink or an image, set [`format: link` or `format: imageUrl`](/reference/data-modeling/dimensions#format) on the dimension in the data model — the table has no chart-side control for this.

Fix this →

Comment on lines +216 to +222
Alignment is set independently in each of the three sections, and their defaults differ: headers align left, totals align right, and values follow the column's data type — numbers right, everything else left. A column's own alignment, set in the **Columns** section, overrides all three.

<Note>

Because the values default follows the data type, the alignment control in the **Values** section shows left until you set it, even where numeric columns are drawn right-aligned. Choosing left there is still meaningful: it pins numeric columns to the left instead of letting them follow their data type.

</Note>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "values follow the column's data type — numbers right, everything else left" rule is now stated three times on this page: the Alignment row at line 42, the prose here at line 216, and again in the <Note> at 220. docs-mintlify/CLAUDE.md explicitly calls this out — "Don't restate the same point in prose and again in a callout."

The Note's genuinely new content is only its second half (choosing left pins numeric columns left rather than being a no-op), which is worth keeping. Suggest collapsing to that:

Suggested change
Alignment is set independently in each of the three sections, and their defaults differ: headers align left, totals align right, and values follow the column's data type — numbers right, everything else left. A column's own alignment, set in the **Columns** section, overrides all three.
<Note>
Because the values default follows the data type, the alignment control in the **Values** section shows left until you set it, even where numeric columns are drawn right-aligned. Choosing left there is still meaningful: it pins numeric columns to the left instead of letting them follow their data type.
</Note>
Alignment is set independently in each of the three sections, and their defaults differ: headers align left, totals align right, and values follow the column's data type. A column's own alignment, set in the **Columns** section, overrides all three.
<Note>
The **Values** alignment control shows left until you set it, even where numeric columns are drawn right-aligned. Choosing left there is still meaningful: it pins numeric columns to the left instead of letting them follow their data type.
</Note>

Comment on lines 128 to +138
<Note>

Internally, sparklines are powered by additional queries grouped by time dimension and granularity: measures sharing the same dimension and granularity are fetched together, so a chart with several sparklines runs at most one extra query per distinct dimension and granularity combination.

</Note>

{/* TODO: screenshot — a numeric column card showing the Value toggle beside the Bars / Sparkline pair */}

| Option | Description |
|---|---|
| **Display as** | On the segmented **Value / Bars / Sparkline** toggle, choose **Sparkline**. Available only for numeric columns, and only when the query has a time dimension. |
| **Horizontal axis** | The time dimension plotted along the sparkline. Auto-selected (the first time dimension in the query); change it here when the query has several. |
| **Horizontal axis** | The time dimension plotted along the sparkline. Picked for you when the view offers only one; choose it here when there are several. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Structural nit: the sparkline option table is now separated from its Sparklines heading by four paragraphs, two <Note> callouts, and a screenshot placeholder — so an unlabelled two-column table appears with no nearby cue that it lists sparkline options. The Inline bars section keeps its table right under the intro; this one drifted as content was inserted.

Moving the implementation-detail <Note> (the "powered by additional queries" one, line 128–132) below the table would restore the pattern — that Note is background, not something the reader needs before configuring the chart.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant