docs: reconcile table chart page with the shipped Style tab and document its gaps - #11451
docs: reconcile table chart page with the shipped Style tab and document its gaps#11451igorlukanin wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
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
Verification I could do
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
Nits (no action needed)
What's goodThe 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. |
| 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. |
There was a problem hiding this comment.
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:
| 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. |
| 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> |
There was a problem hiding this comment.
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:
| 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> |
| <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. | |
There was a problem hiding this comment.
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.
Summary
Test plan
mintlify dev: page returns 200, no MDX errors, new sections present and removed content gone#display-tabanchor, and that the#sortingand#conditionstargets resolveScreenshot placeholders for the new sections are left unresolved, in the documented form — capture is tracked separately.