Skip to content

docs: document dashboard stack containers - #11779

Open
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-zjhiik
Open

docs: document dashboard stack containers#11779
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-zjhiik

Conversation

@keydunov

@keydunov keydunov commented Sep 6, 2026

Copy link
Copy Markdown
Member

Check List

  • Tests have been run in packages where changes have been made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet
  • Docs have been added / updated if required

Description of Changes Made

Cube Cloud shipped a new dashboard widget — horizontal and vertical stack containers (CUB-4271) — that had no documentation yet. This PR:

  • Renames the "Spacer & Divider" widget page to Layout widgets and adds a Stack section covering: the two orientations, even space distribution among children, drag-to-add with the slot preview, the 4-level nesting limit, and that controls (filter, time granularity, field switcher, parent) keep driving the dashboard when placed inside a stack.
  • Updates the widget type list on the widgets index page and the "Adding a layout widget" instructions to include the new stack options.

Facts were verified against the source PR (cubedevinc/cubejs-enterprise#14632) and the shipped UI copy (horizontalStack/verticalStack/dragWidgetsIntoStack strings, MAX_CONTAINER_DEPTH = 4).

🤖 Generated with Claude Code

https://claude.ai/code/session_016tvjJd9nhs2pffpqEwYXXw


Generated by Claude Code

Horizontal and vertical stack containers (CUB-4271) shipped as a new
layout widget that groups other widgets along one axis, with a
4-level nesting limit and working controls inside. Rename the
Spacer & Divider page to Layout widgets and add a Stack section.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016tvjJd9nhs2pffpqEwYXXw
@mintlify

mintlify Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
cubed3 🟢 Ready View Preview Sep 6, 2026, 12:12 AM

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

@claude

claude Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keydunov's task in 1m 3s —— View job


Docs review: solid, ships as-is — 3 low-severity nits (2 posted inline)

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Verify all four anchor links into controls.mdx
  • Check docs.json nav + cross-references to the renamed page
  • Check consistency with docs-mintlify/CLAUDE.md conventions
  • Post review

What checks out

  • All four anchors resolve. #filter, #time-granularity-switcher, #field-switcher, #parent each match an existing H2 in controls.mdx (lines 15, 81, 134, 192).
  • Nav is fine. docs.json:120 registers the page by path, not label, so the rename needs no docs.json edit. grep finds no other reference to the page or to the old "Spacer & Divider" label anywhere in docs-mintlify/.
  • Style matches the repo conventions. Root-relative internal links, no body H1, second person, short paragraphs, no padding — this is a surgical edit to an existing page rather than a new one, which is exactly what docs-mintlify/CLAUDE.md asks for.
  • Good catch on line 37: narrowing "Both widgets" → "The spacer and divider" when a third widget joined the page. Easy thing to miss.

Findings

# Severity File Note
1 low layout.mdx:2 Title Layout widgets breaks the bare-noun pattern of sibling pages and disagrees with the index link text — inline
2 low layout.mdx:37 Styling section now silently excludes stack; reader is left wondering — inline
3 low docs-mintlify/CLAUDE.md Product taxonomy not updated — below

3 — docs-mintlify/CLAUDE.md product taxonomy is now stale. The taxonomy block lists:

          - Layout
            - Spacer
            - Divider

Stack is a new child of Layout and belongs there. That file is the canonical naming source future doc work reads from, so leaving it out means the next person writing about this widget has no sanctioned term to reach for. One line:

          - Layout
            - Stack
            - Spacer
            - Divider

Fix this →

One thing I could not verify

The "nested up to 4 levels deep" claim and the MAX_CONTAINER_DEPTH = 4 constant live in cubedevinc/cubejs-enterprise, which isn't in this checkout. Flagging only because off-by-one is the classic failure mode here — a constant named MAX_CONTAINER_DEPTH could plausibly mean "4 nested stacks" or "3 nested inside a root". Worth a glance at the call site before merge.

No tests, security, or performance surface — documentation-only change.

· branch [`claude/gallant-ramanujan-zjhiik`](https://github.com/cube-js/cube/tree/claude/gallant-ramanujan-zjhiik)

---
title: Spacer & Divider
description: Non-data layout elements — a spacer for whitespace and a divider line — that help you structure a dashboard.
title: Layout widgets

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.

Sibling pages in this group use bare nouns as titles — Charts, Text, Controls, AI summary. Layout widgets is the odd one out, and since the sidebar group is already Widgets, the suffix reads as redundant there. It also doesn't match the link text you used on the index page (- [Layout](...)).

Suggested change
title: Layout widgets
title: Layout

## Styling

Both widgets follow the dashboard's [widget styling settings](/docs/explore-analyze/dashboards/styling):
The spacer and divider follow the dashboard's [widget styling settings](/docs/explore-analyze/dashboards/styling):

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.

Narrowing this from "Both widgets" to "The spacer and divider" is correct, but it leaves stack unaddressed: a reader who just learned about a third layout widget will wonder whether a stack picks up the dashboard's border/background settings, and this section now silently excludes it. Worth one clause either way — e.g. "A stack is invisible on the published dashboard and takes no styling of its own." (assuming that's what the implementation does).

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.

2 participants