Skip to content

docs(table-chart): sparkline point-count note and granularity guidance#11209

Open
igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-2410-sparkline-volume-guidance-docs
Open

docs(table-chart): sparkline point-count note and granularity guidance#11209
igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-2410-sparkline-volume-guidance-docs

Conversation

@igorlukanin

Copy link
Copy Markdown
Member

Documents the creator-side sparkline fetch-volume guidance added in CUB-2410 review: the per-column sparkline options now show how many points each sparkline plots at the selected granularity, with a warning (and a suggested granularity) when the count leaves the useful range. Also corrects the Show value description: the headline is the measure's row-grain value, not the most recent bucket.

Companion to https://github.com/cubedevinc/cubejs-enterprise/pull/12784.

@igorlukanin igorlukanin requested a review from keydunov as a code owner July 6, 2026 22:48
@claude

claude Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 33s —— View job


Code Review

Docs-only change (+4/-2) to docs-mintlify/docs/explore-analyze/charts/chart-types/table.mdx. Reviewed against the PR body and docs-mintlify/CLAUDE.md conventions.

Verdict: LGTM — 0 blocking, 2 nits

What the diff does

  • Corrects the Show value row to clarify the headline mirrors the cell's own measure value (row-grain), not the most-recent-bucket value. This matches the PR description and is a real correctness fix in the docs.
  • Adds a paragraph after the sparkline options table describing the creator-only point-count note + warning icon, including the suggested-granularity tooltip and the fact that viewers don't see it.
  • Extends the existing granularity <Note> with a pointer to the new note/warning as the intended guide for picking granularity.

Alignment with conventions

  • ✅ Edited in /docs-mintlify (not the deprecated /docs), per root and Mintlify CLAUDE.md.
  • ✅ Uses existing <Note> component; no new components introduced.
  • ✅ Second person ("you as the chart's creator"), professional/instructive tone.
  • ✅ No H1 added; frontmatter untouched.
  • ✅ Concise, no unnecessary structural churn.

Nits (non-blocking)

  • table.mdx:149 — "the same number the cell would show without a sparkline" is a helpful gloss, but the em-dash aside makes the sentence long. Consider tightening to: "Show the measure's value for the row as a headline next to the sparkline — the same number the cell would show otherwise. Turn it off for a chart-only cell." Purely stylistic.
  • table.mdx:153 — "the options above show" is slightly indirect since the sentence lives immediately below the table; "the option list above" or "the sparkline options" reads a hair more concretely. Optional.

Not applicable here

  • Security, performance, tests, API/schema surface — none touched.
  • No screenshots added; existing {/* TODO screenshot: ... */} placeholder unchanged, which is fine.
· Branch: `igor/cub-2410-sparkline-volume-guidance-docs`

@mintlify

mintlify Bot commented Jul 6, 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 Jul 6, 2026, 10:50 PM

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

@igorlukanin igorlukanin force-pushed the igor/cub-2410-sparkline-volume-guidance-docs branch from 9e8b8da to 2c42f4a Compare July 7, 2026 11:49
@claude

claude Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 34s —— View job


Code Review

Docs-only update (+2/-2) on docs-mintlify/docs/explore-analyze/charts/chart-types/table.mdx. Re-reviewed after latest push.

Verdict: LGTM — 0 blocking, 1 nit

What changed since the last review

  • table.mdx:149Show value description now reads: "Show the measure's value for the row — the same number the cell would show without a sparkline — as a headline next to it." The correctness fix (row-grain, not most-recent-bucket) is preserved, and the em-dash aside from my earlier nit is kept as clarifying context. Reads well.
  • table.mdx:155 — Granularity <Note> reworded to: "Choose a reasonable granularity for the data's time span. An overly fine granularity (e.g. by the second over several years) makes the background queries return many rows and can compromise the chart's performance." Tighter and clearer than the previous version.

Note: the earlier PR description mentioned a follow-up paragraph pointing viewers/creators to the in-product point-count warning; that paragraph isn't in this diff. If it's intentionally deferred to a separate PR, ignore — otherwise worth double-checking it didn't get dropped.

Alignment with conventions

  • Edited in /docs-mintlify (not deprecated /docs).
  • Second person, professional tone, no new components introduced.
  • Frontmatter untouched, no H1 added.

Nits (non-blocking)

  • table.mdx:155 — "compromise the chart's performance" is slightly euphemistic vs. the user-visible symptom. Consider "…and can make a table with sparklines slow to load." Optional.

Not applicable
Security, performance, tests, API surface — none touched.

· Branch: `igor/cub-2410-sparkline-volume-guidance-docs`

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