docs(dashboards): document the Grid container widget - #11556
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @mngr's task in 1m 21s —— View job Docs review: approve with nits — 0 high, 2 medium, 2 lowFull review
Docs-only change, so no security/perf/test surface. Prose is clear, well-structured, and reads like the existing widget pages. Two consistency issues are worth resolving before this ships. Medium
Low
Verified correct
On the merge holdWorth restating that nothing in the repo gates this — merging publishes the page immediately, so the "hold until CUB-3811 lands" note in the description is the only safeguard. Also, the description mentions CUB-3892 (drop-sizing refinements) will change how dropped widgets behave; |
Add a Grid container page to the dashboard widgets section, covering: adding a container, the independent inner cols×rows grid, dragging widgets in, arranging (move/resize container + children, move a child out), Distribute evenly, nesting containers, and Edit/Delete. Registers the page in the widgets nav (docs.json) and lists it on the widgets index. Documents the Grid container shipped in cubejs-enterprise PR #13919 (CUB-3811). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
6d191bd to
f6aa3ec
Compare
|
Claude finished @mngr's task in 1m 47s —— View job Docs review: approve with nits — 0 high, 2 medium, 3 lowFull review
Docs-only change — no security, performance, or test surface. Both findings from my earlier pass are now genuinely resolved, not just papered over:
Medium
Low
I'm not re-raising the missing Verified correct
On the merge holdStill nothing in the repo gates this page — merging publishes it immediately, so the "hold until CUB-3811 lands" note in the description remains the only safeguard. And per the description, CUB-3892 will change drop behavior; |
…r.mdx Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
…r.mdx Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
|
Claude finished @mngr's task in 1m 6s —— View job Docs review: approve with nits — 0 high, 1 medium, 3 lowFull review
Docs-only change; no security, performance, or test surface. Both items I flagged last pass are now fixed in the file:
Medium
Low
Not re-raising the missing One open question rather than a finding: line 40 documents filling a container only via drag ("drop it directly onto the container"). If clicking a toolbar item can also target a selected container, that's worth a clause — otherwise the only documented way to put anything into a container is gated behind the separate drag-to-place preview. You resolved the earlier thread on this, so I've left it as a note here instead of reposting. Verified correct
On the merge holdNothing in the repo gates this page — merging publishes it immediately, so the "hold until CUB-3811 lands" note in the description is still the only safeguard. Per the description, CUB-3892 will change drop behavior; |
| In the [dashboard builder][ref-workbooks], open the **Add Widgets** menu in the toolbar and choose **Grid**. The container is added with an empty inner grid, and its settings panel opens so you can size the grid right away. | ||
|
|
||
| <Steps> | ||
| <Step> | ||
| Open the **Add Widgets** menu in the toolbar and choose **Grid**. If [drag-to-place](/docs/explore-analyze/dashboards/widgets) is enabled for your account, you can instead drag the **Grid** entry to drop the container exactly where you want it. | ||
| </Step> |
There was a problem hiding this comment.
Two small artifacts from applying my earlier suggestion:
- The lead-in paragraph and Step 1 now say the same thing. Line 16 ("open the Add Widgets menu in the toolbar and choose Grid") is repeated verbatim as the first step. Sibling pages either use a lead-in or a
<Steps>block, not both with duplicate content. - Step 1 has no
title. Steps 2 and 3 do, and every<Step>elsewhere in the dashboards docs (controls.mdx:49,52,55) is titled — an untitled step renders with a blank heading next to two titled ones.
Folding the lead-in's outcome into the step body fixes both:
| In the [dashboard builder][ref-workbooks], open the **Add Widgets** menu in the toolbar and choose **Grid**. The container is added with an empty inner grid, and its settings panel opens so you can size the grid right away. | |
| <Steps> | |
| <Step> | |
| Open the **Add Widgets** menu in the toolbar and choose **Grid**. If [drag-to-place](/docs/explore-analyze/dashboards/widgets) is enabled for your account, you can instead drag the **Grid** entry to drop the container exactly where you want it. | |
| </Step> | |
| <Steps> | |
| <Step> | |
| In the [dashboard builder][ref-workbooks], open the **Add Widgets** menu in the toolbar and choose **Grid**. The container is added with an empty inner grid, and its settings panel opens so you can size the grid right away. If [drag-to-place](/docs/explore-analyze/dashboards/widgets) is enabled for your account, you can instead drag the **Grid** entry to drop the container exactly where you want it. | |
| </Step> |
What
Documents the Grid container dashboard widget — a widget that holds other widgets in its own independent
cols × rowsgrid so authors can group, arrange, move, and resize related tiles (and nest containers) on a dashboard.Adds
docs-mintlify/docs/explore-analyze/dashboards/widgets/container.mdxand wires it into:docs.jsonThe page covers: adding a Grid container, the inner grid (independent cols×rows, auto-growing rows), dragging widgets in, arranging (move/resize the container, resize children, move a child out), Distribute evenly, nesting containers, and the Edit/Delete menu — matching the existing charts / text / controls / AI-summary widget pages in tone and structure.
Companion to the feature PR
This documents the Grid container shipped in cubejs-enterprise PR #13919 (Linear CUB-3811). That feature is currently in review and gated behind the
useBoardDashboardsflag.Draft on purpose — please hold merge until the feature PR lands and the container is enabled for users, so the public docs don't describe a feature that isn't live yet.
Validation
mintlify broken-links --check-anchors --check-redirects --check-snippets→ no broken links founddocs.jsonis valid JSONdocs-mintlify/CLAUDE.mdconventions (Widget taxonomy under the dashboard builder; no legacy "Cube Cloud" naming;<Steps>for procedures)Known follow-up
Drop-sizing refinements (keep dragged size / downscale-to-fit / swap-on-collision) are tracked separately in CUB-3892 and intentionally not documented here — today dropped widgets snap to grid cells, which the page describes accurately.
🤖 Generated with Claude Code