docs: reconcile pie/donut and KPI chart pages, document is empty/is not empty filter operators - #11466
docs: reconcile pie/donut and KPI chart pages, document is empty/is not empty filter operators#11466keydunov wants to merge 1 commit into
Conversation
…pty filter operators - Pie & donut: replace the removed inner-radius slider with the Shape (Pie/Donut) toggle, and document Rings (concentric multi-dimension pies), the Measure field, the rebuilt Data labels panel, and the Tooltips field picker (CUB-3180, CUB-3183, CUB-3185). - KPI: add Label and Value format to Progress bar and Sparkline blocks, add Show percent/Show target and Show value/Show trend toggles, drop the Sparkline 'Chart type' row and Comparison 'Difference format' row that don't correspond to any shipped control, and add a Per-block styling section covering per-block alignment and color/font settings (CUB-2945, CUB-3540, CUB-3113/#13113). - Filters: document the new is empty / is not empty string operators in the dashboard Filter widget and in default_ui_filters (CUB-3231, cubejs-enterprise#13456).
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @keydunov's task in 2m 18s —— View job Review: docs-only, no blockers — 0 high, 2 medium, 4 lowDocs-only change across 4 Full review — findings, checklist, and verification notesChecklist
Medium
Low
What checks out
Not verifiedAccuracy of the control inventories against the shipping |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
|
|
||
| | Atom | Description | | ||
| |---|---| |
There was a problem hiding this comment.
There's already a shared page at docs/explore-analyze/charts/configuration/data-labels.mdx for data labels, and it describes a different UI: labels are enabled from a Data Labels toggle in the Fields tab, settings are Format / Font size / Position, and Position offers Outside end / Inside end / Inside center / Inside base.
This new section says Style tab, per-atom toggles, and Inside/Outside only. Both can be true (pie may genuinely have its own panel), but a reader who lands on the shared page first will follow instructions that don't exist for pie. Worth a one-line cross-link plus an explicit "pie/donut labels differ from the stacked-bar data labels" note here — and ideally scoping the shared page's title/intro to stacked bars.
|
|
||
| ## Color and slice ordering | ||
|
|
There was a problem hiding this comment.
Two small consistency nits against the rest of the charts docs:
scatter.mdxends its Tooltips section withSee [Tooltips](/docs/explore-analyze/charts/configuration/tooltips) for details.— worth doing the same here rather than leaving this as the only Tooltips section with no pointer to the shared page.- The shared page calls the slot Tooltip ("The Tooltip section shows…"), this says Tooltips. Pick one label so search on the UI string lands somewhere consistent.
| | **Number** | Value color, background color, and font size (in pixels) | | ||
| | **Comparison** | Positive/negative colors for the change, plus a neutral color and background for the unchanged state | | ||
| | **Progress bar, Sparkline, HTML** | Background color | |
There was a problem hiding this comment.
This drops the Progress bar's fill color from the docs entirely: the old table row (**Color** | Fill color for the progress indicator) was removed, and here Progress bar is listed as Background color only. If the fill color control still exists (it very likely does — a progress bar has to get its fill from somewhere), that's a regression in coverage, not a reconciliation. Please double-check the Style tab for Progress bar and add the fill/indicator color row if it's there.
Related: Sparkline's Colors | Line and area-fill colors is still in the Data tab table above while Number's and Comparison's colors were moved down into this Style section. If sparkline colors live on the Style tab too, move that row here so the split is "Data tab = fields/format, Style tab = colors/fonts" throughout.
| | **Colors** | Line and area-fill colors | | ||
| | **Format** | Number formatting for the headline value | | ||
|
|
||
| By default, the headline value is the series measure's own latest value; toggle **Headline uses measure** off to source it from a different column instead. |
There was a problem hiding this comment.
Headline uses measure is a real control but it's only mentioned in prose — every other Sparkline control is in the table above. Add it as a row (and the "different column" field it reveals, if that's a separate picker), so the table stays the complete inventory of the block's settings.
Also worth reconciling with Show value two rows up: "Show value — Display the headline value above the trend line" vs. this paragraph's "the headline value is the series measure's own latest value". Reading them together it's not obvious that Show value gates visibility while Headline uses measure gates the source.
| Category and Value are on by default. Toggling the first atom on adds the label layer to the chart; toggling the last one off removes it. | ||
|
|
||
| Additional controls appear once at least one atom is on: | ||
|
|
There was a problem hiding this comment.
These two sentences fight each other: if Category and Value are on by default, then the label layer is on by default, so "toggling the first atom on adds the label layer" only describes the recovery path after a user turns everything off. Suggest stating the default outcome first, e.g. "Labels are on by default with Category and Value. Turning every atom off removes the label layer; turning any atom back on restores it."
| The KPI visualization starts with a **Number** block that compares the first and second rows of your result for the first numeric column. | ||
|
|
||
| To add a new block, click the **+** button inside the visualization and choose the block type. To edit a block, click it in the visualization — the configuration panel updates to show that block's settings. | ||
| To add a new block, click the **+** button inside the visualization and choose the block type. To edit a block, click it in the visualization — the configuration panel updates to show that block's settings, split into a **Data** tab and a **Style** tab. |
There was a problem hiding this comment.
Every other page under charts/ refers to the two panels as the Fields tab and the Style tab (tooltips.mdx, data-labels.mdx, series-mapping.mdx, scatter.mdx, axes.mdx, color-and-stacking.mdx). This introduces Data as a third name. If the KPI panel genuinely says "Data", worth a parenthetical so readers don't hunt for a Fields tab; if it says "Fields", align it here.
2 participants
Summary
Found while cross-checking recent
cubejs-enterprisemerges againstdocs-mintlifyfor undocumented customer-facing changes.docs/explore-analyze/charts/chart-types/pie.mdx): the donut shape used to be documented as "drag the Inner radius slider to any non-zero value" — that control was removed in favor of an explicit Shape (Pie/Donut) toggle (CUB-3183). Also documents features that shipped with no docs at all: concentric Rings for multi-dimension pies (CUB-3180), the Measure field, the rebuilt Data labels panel (content atoms, position, labeled rings, CUB-3185), and the Tooltips field picker.docs/explore-analyze/charts/chart-types/kpi.mdx):is empty/is not emptystring operators (CUB-3231, cubejs-enterprise#13456) in the dashboard Filter widget's operator table (docs/explore-analyze/dashboards/widgets/controls.mdx) and indefault_ui_filters's operator list (reference/data-modeling/view.mdx), with a note distinguishing them from the existingis null/is not nullnull-checks.All of the above were verified by reading the shipping source in
cubejs-enterprise(component code + i18n strings), not just PR titles, per the customer-facing docs criteria.Not included in this PR: the new Dashboard Apps authoring editor (CUB-3544) is a large, brand-new feature with no existing docs home and some open product questions, so it's tracked separately as CUB-3657 rather than a surgical edit here.
Test plan
cd docs-mintlify && yarn devand spot-check the four edited pages render correctlyis empty/is not emptyappear in the workbook filter bar's string operator list🤖 Generated with Claude Code
Generated by Claude Code