Skip to content

docs: correct the donut shape control and document the center total - #11520

Open
igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-3186-donut-total-docs
Open

docs: correct the donut shape control and document the center total#11520
igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-3186-donut-total-docs

Conversation

@igorlukanin

Copy link
Copy Markdown
Member

The pie & donut page describes an Inner radius slider that no longer exists — the control is now a Pie / Donut shape selector in the Style tab, and the hole is a fixed fraction of the chart rather than a pixel value a user drags.

It also suggested overlaying a KPI tile on a dashboard to get a summary value in the hole. The donut now renders the measure's grand total itself, behind a Show total switch, so that workaround is no longer the answer.

Updates both sections to what the product actually does. No new pages; the screenshot placeholders are carried over and re-worded to match.

@igorlukanin
igorlukanin requested a review from keydunov as a code owner August 11, 2026 02:59
@mintlify

mintlify Bot commented Aug 11, 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 11, 2026, 3:00 AM

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

@claude

claude Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

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


Review: docs accuracy fix — looks good, one trim suggested

Verdict: approve with nits. 0 high, 1 medium, 3 low. The correction itself is right and the page reads better than before. One inline comment posted.

Full review — todos, findings, and notes

Todos

  • Gather context (diff, full file, sibling chart pages, docs conventions)
  • Understand the request — PR review
  • Check for broken anchors / cross-links elsewhere in the docs
  • Check claims against source (chart UI is not in this repo — see caveat)
  • Check dedup against prior review threads (none existed)
  • Post review

What's good

  • The core correction is the valuable part: an Inner radius slider that doesn't exist is worse than no docs, and the KPI-tile-overlay workaround actively pointed users at the wrong solution. Both are gone.
  • Section rename from ## Inner radius## Show total correctly follows the semantics of the control rather than keeping a stale heading alive.
  • Screenshot placeholders were re-worded rather than dropped, so the outstanding image work doesn't get silently lost.
  • Line 26 first clause ("appears only for a donut") preempts the obvious support question — good instinct.

Findings

Medium — pie.mdx:26, state-retention sentence (inline)
"Switching back to a pie hides the total and remembers the setting, so returning to a donut restores it" documents transient UI state. It's padding per docs-mintlify/CLAUDE.md ("Do not pad… write the shortest version that fully answers 'how do I use this?'"), and it's the line most likely to go stale without anyone noticing. Suggested cut in the inline comment.

Low — pie.mdx:24, redundant clause
"The total uses the measure's own number format, so changing the format of the measure changes the total with it." The so clause restates the first clause. Consider just: "The total uses the measure's number format."

Low — pie.mdx:22, heading is a UI label
Sibling pages use conceptual headings (## Stacking, ## Color and slice ordering, ## Variants). ## Show total is a literal switch label. ## Center total with Show total bolded in the prose would match the house style better — though the literal label is arguably more findable via search, so this is a judgment call.

Low — dropped #inner-radius anchor and KPI cross-link
Nothing in-repo links to pie#inner-radius (verified by grep across .mdx and docs.json), so no internal breakage. External inbound links to that anchor will land at the top of the page instead. Not worth preserving via {#inner-radius} here since the section's meaning changed entirely — flagging only for awareness. Same for the removed link to the KPI page: correct to drop the bad workaround, just noting pie.mdx no longer cross-links to kpi.mdx at all.

Verification caveat

The factual claims — that the control is a Shape selector, that Show total exists and is donut-only, that the total inherits the measure's number format, and that the setting persists across shape switches — cannot be verified from this repo. grep for showTotal / innerRadius across all .ts/.tsx/.js returns nothing; the chart configuration UI lives in the Cube Cloud frontend. I'm taking these on the author's word and reviewing for docs quality, consistency, and link integrity only.

The other review dimensions in the standing instructions (security, performance, error handling, test coverage) don't apply — this is a 7-line prose change to a single .mdx file with no code, no build step, and no test surface.

· branch [`igor/cub-3186-donut-total-docs`](https://github.com/cube-js/cube/tree/igor/cub-3186-donut-total-docs)

Turn on **Show total** in the Style tab to render the measure's grand total in the donut's hole. The total uses the measure's own number format, so changing the format of the measure changes the total with it.

{/* Screenshot: Style tab with the Inner radius control highlighted. Place inline, 50% width, right-aligned. (hidden — replace this comment with <Frame><img src="..." /></Frame> when image is ready) */}
The option appears only for a donut, since a pie has no hollow center to fill. Switching back to a pie hides the total and remembers the setting, so returning to a donut restores it.

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 first clause earns its place — it answers "why can't I find this control?" for someone looking at a pie. The second one documents transient UI state (a toggle remembering its position), which is the kind of detail docs-mintlify/CLAUDE.md calls out as padding ("write the shortest version that fully answers 'how do I use this?' and stop"), and it's the sentence most likely to silently go stale if the widget config handling ever changes.

Suggested change
The option appears only for a donut, since a pie has no hollow center to fill. Switching back to a pie hides the total and remembers the setting, so returning to a donut restores it.
The option appears only for a donut, since a pie has no hollow center to fill.

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