Skip to content

docs: add the funnel chart type page - #11619

Open
igorlukanin wants to merge 2 commits into
masterfrom
igor/docs-funnel-chart
Open

docs: add the funnel chart type page#11619
igorlukanin wants to merge 2 commits into
masterfrom
igor/docs-funnel-chart

Conversation

@igorlukanin

Copy link
Copy Markdown
Member

Adds the Funnel page to the workbook chart-types docs — fields, conversion percentages on the connectors, data labels, and color — and lists it in the chart-types index. Also updates the recommendation section's never-recommended list to include the funnel.

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

mintlify Bot commented Aug 21, 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 21, 2026, 7:01 PM

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

@claude

claude Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

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


Docs-only PR — no blocking issues. 0 high, 1 medium, 3 low. 3 inline comments posted.

Full review

Todos

  • Read the PR diff
  • Compare against sibling chart-type pages for conventions
  • Verify claims against implementation (not possible — see below)
  • Check docs.json nav wiring & index links
  • Post review

Scope

Three files, docs-only, in /docs-mintlify — the active docs site per CLAUDE.md. No code, so the security / performance / test-coverage axes of the review checklist don't apply here. I reviewed for accuracy, consistency with sibling pages, and nav wiring.

What's correct

  • Nav wiring is sound. docs.json:74 places funnel between pie and heatmap, and index.mdx:13 uses the identical order and a matching root-relative link. No orphaned page, no broken link.
  • Arithmetic in the recommendation section is right — "All four" → "All five" tracks the added entry (Pie, funnel, area, boxplot, HTML).
  • Frontmatter matches the house style (title + description, both present), and the hidden-screenshot placeholder comment follows the exact convention used in pie.mdx, boxplot.mdx, and area.mdx.
  • The writing itself is good. A stage whose value is zero still draws, as a thin line […] so a gap in the data reads as a zero rather than as a missing stage and the note that the chart deliberately won't sort a growing stage away are the kind of "why it behaves this way" details most chart docs omit.

Findings

# Severity Where Issue
1 Medium index.mdx:83-85 Rationale sentence now only explains Pie, but reads as covering the funnel; also exceeds the file's ~98-char wrap
2 Low funnel.mdx:38 Only chart-type page mentioning palettes that doesn't link to configuration/color-and-stacking; Palette dropdown vs. Color section terminology unconfirmed
3 Low funnel.mdx:6 No cross-link to the existing recipes/data-modeling/funnels.mdx recipe, which produces exactly this chart's data shape
4 Low whole file Only one screenshot placeholder, at the top

On #4: sibling pages seed a placeholder per configurable section — pie.mdx has three (one per variant plus the Style-tab control), heatmap.mdx:20 has one on the Style tab Color section, scatter.mdx:32 one on the Fields tab. This page documents three distinct control clusters (Fields tab, Data labels toggles, Palette) with no placeholder for any of them, so whoever fills in screenshots later has no marker to work from. Not worth blocking on; just cheaper to add now.

One caveat on verification

The funnel chart implementation isn't in this repo — grep -ri funnel packages/ returns only the data-modeling recipe, nothing in the workbook UI. So I could not verify the behavioral claims against source: the exactly-two-fields requirement, the 36% of first / 20% of previous label strings, which toggles default on, the zero-value thin-line rendering, the white→dark label color switch on narrow bars, or that font size is shared between bar labels and connector percentages. Those all need a human who can check the workbook code or the running UI. Flagging so the specificity of this page isn't mistaken for verified specificity.

· [`igor/docs-funnel-chart`](https://github.com/cube-js/cube/tree/igor/docs-funnel-chart)

Comment thread docs-mintlify/docs/explore-analyze/charts/chart-types/index.mdx Outdated
Comment thread docs-mintlify/docs/explore-analyze/charts/chart-types/funnel.mdx Outdated
description: Show how a value narrows from stage to stage, such as signup → activation → purchase.
---

Funnel charts draw one bar per stage, centered on a shared midline, with a connector between each adjacent pair of stages. Each bar's width is proportional to its stage's value, so the figure narrows wherever values drop. Best for stage-to-stage conversion: how many users, orders, or events survive each step of a process.

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.

Nit / opportunity: the repo already has recipes/data-modeling/funnels.mdx — "Implementing funnel analysis" with the packaged Funnels helper. That recipe produces exactly the step + conversions shape this chart consumes, so a one-line pointer here (and ideally a link back from the recipe) would make the modeling → visualization path discoverable. Something like: "To model the stages themselves, see Implementing funnel analysis."

Separately, that recipe doesn't appear in docs.json at all (grep -i funnel docs.json matches only the new chart page), so it may be unreachable from the sidebar. Out of scope for this PR, but worth a follow-up.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Skipping this one. recipes/data-modeling/funnels.mdx is hidden: true in its frontmatter, so its absence from docs.json is deliberate rather than an oversight, and linking it from a listed page would surface it against that. Worth revisiting if the recipe is ever unhidden.

…ts legend, and reflow the recommendation rationale
@claude

claude Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

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


Re-review of 375cb8d — 2 of 3 prior threads addressed. 0 high, 0 medium, 3 low. 2 new inline comments.

Full review

Todos

  • Read the updated diff (git diff origin/master...HEAD)
  • Verify the new #palettes anchor resolves
  • Check the new Legend section against the shared config page
  • Resolve stale threads, dedupe against prior comments
  • Post review

What the new commit fixed

  • Recommendation rationale (index.mdx:83-87) — reflowed to the file's wrap width and now explains the funnel on its own terms ("asserts that its stages are sequential steps of one process, which the shape of a query does not reveal"). Thread resolved.
  • Palette link (funnel.mdx:42) — now points at color-and-stacking#palettes. I checked the target: color-and-stacking.mdx:24 is ## Palettes, so the anchor resolves. Thread resolved.
  • Screenshot placeholders — went from one to four, one per configurable cluster (Fields, Data labels, Palette). That was finding Self reference guard in schema compiler #4 last round; it's covered.
  • New Legend section — genuinely new information, not in the previous revision.

Line lengths in funnel.mdx (max 323) are in line with siblings (bar.mdx 304, line.mdx 301, pie.mdx 296) — the ~98-char wrap only applies to index.mdx, and that's now respected.

Remaining findings

# Severity Where Issue
1 Low funnel.mdx:42 Link target's own scope sentence (color-and-stacking.mdx:6) lists "bar, line, area, scatter, and heatmap" — not funnel
2 Low funnel.mdx:48 New Legend section doesn't link to #legend; and that page says the legend appears "when a Color channel is assigned", which the funnel has none of
3 Low funnel.mdx:6 Prior thread, still open: no cross-link to recipes/data-modeling/funnels.mdx

Finding #3 is a re-affirm — the existing unresolved thread still applies, so I didn't post a duplicate.

Verification caveat (unchanged)

The funnel implementation still isn't in this repo, so the behavioral specifics — exactly-two-fields, the 36% of first / 20% of previous strings, which toggles default on, zero-value thin-line rendering, the white→dark label switch, shared font size — remain unverifiable from here. The Legend section added in this commit is in the same category. A human with access to the workbook code or a running instance needs to confirm them.

· [`igor/docs-funnel-chart`](https://github.com/cube-js/cube/tree/igor/docs-funnel-chart)


## Color

Each stage takes its own color from the palette selected in the **Palette** dropdown on the Style tab, in palette order. See [Palettes](/docs/explore-analyze/charts/configuration/color-and-stacking#palettes) for the built-in palettes and how to define a custom one.

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 #palettes anchor resolves — color-and-stacking.mdx:24 is ## Palettes. 👍

One leftover from the previous round: that page's scope sentence (color-and-stacking.mdx:6) still says the Color-section settings "apply across bar, line, area, scatter, and heatmap charts". A reader following this link lands on a page that, by its own first paragraph, excludes the funnel. Either add funnel to that list, or narrow the claim there to the parts that are chart-type-specific. (Pie has the same gap, so it's a pre-existing seam — but this PR is what makes it reachable.)


## Legend

A legend naming each stage in its palette color is available in the **Legend** section of the Style tab, along with its placement.

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.

Two notes on the new Legend section:

  1. No link out, unlike the Color section right above it. color-and-stacking.mdx:87 documents the same Legend section (Position: right/left/top/bottom; Hidden), so [Legend](/docs/explore-analyze/charts/configuration/color-and-stacking#legend) would save repeating the placement options here.
  2. Possible contradiction with that page. It says "The legend appears when a Color channel is assigned" — the funnel has no Color channel (## Fields above says exactly two fields, Stage and Value), yet this page says a legend is available. Both can't be describing the same rule. Worth confirming which is right before linking them together.

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