Skip to content

docs: document undocumented customer-facing changes from the last few days - #11626

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

docs: document undocumented customer-facing changes from the last few days#11626
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-pn1ghu

Conversation

@keydunov

Copy link
Copy Markdown
Member

Check List

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

Description of Changes Made

Routine audit of recent cubejs-enterprise changes cross-checked against docs-mintlify, filtered through the customer-facing criteria. Four undocumented customer-facing changes, all fitting as edits to existing pages:

  • Embedding → Dashboards / Events: allowExport=true now gates PNG and PDF widget export in addition to CSV (previously CSV-only), plus the new "one export in flight per dashboard" toast (CUB-4065, cubejs-enterprise#14290).
  • Workbooks → Calculated fields: the bins/value-groups panel gained custom per-bucket labels, renamed Boundaries/Equal intervals tabs with a Number-of-bins-vs-Bin-size choice, optional separate handling of empty values, an edit action on existing value groups, and an opt-out of the Other bucket in favor of NULL (cubejs-enterprise#14324).
  • Workbooks → Calculated fields: editing a calculated field now opens from a row-menu Edit action (not just the sidebar), reopens the bins/groups panel for a generated field, and no longer offers renaming an existing field (cubejs-enterprise#14322).
  • Integrations → dbt: the agent can now author and validate a dbt model from Analytics Chat (open a live sandbox, read project conventions, draft/write/dbt parse+compile a model) before handing it back for you to push — beyond the existing sync-only chat trigger (CUB-3964, cubejs-enterprise#14298).

One change was scoped down to a big item needing its own new docs page rather than a page edit — a new Funnel chart type (cubejs-enterprise#13506) — and is being tracked separately rather than included here. Two other candidate changes were investigated and skipped as not customer-facing: an internal Support MCP OAuth change (staff-only tool, no customer surface) and an ai-engineer "dashboard app file tools" refactor (no new customer-visible capability, per the design doc it replaces an existing whole-file tool with a more granular one).


Generated by Claude Code

… days

* docs(embedding): document PNG/PDF export for embedded dashboard widgets

allowExport=true now gates Download as CSV, PNG, and PDF (previously CSV
only), with a per-dashboard export-in-flight limit surfaced as a toast
(CUB-4065).

* docs(workbooks): document expanded bins and value groups options

Custom bucket labels, the renamed Boundaries/Equal intervals tabs with a
Number of bins vs. Bin size choice, optional separate handling of empty
values, editable existing groups, and an opt-out of the Other bucket in
favor of NULL (#14324).

* docs(workbooks): document the calculated field row-menu Edit action

Editing now opens from a field's row menu (not just the sidebar), reopens
the bins/groups panel for a generated field, and no longer offers renaming
(#14322).

* docs(dbt): document authoring and pushing a dbt model from Analytics Chat

The agent can open a live dbt sandbox, read the project's conventions, and
draft/write/validate a model's files before handing it back for you to
push — beyond the existing sync-only chat trigger (CUB-3964).

---------

Co-authored-by: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 24, 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 24, 2026, 12:22 AM

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

@claude

claude Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keydunov's task in 2m 6s —— View job


Docs review: approve with nits — 0 blocking, 2 medium, 2 low (4 inline comments)

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Verify internal links / anchors resolve
  • Check Mintlify conventions (frontmatter, components, custom anchors)
  • Check prose accuracy & cross-page consistency
  • Post review

Verified

  • All internal links resolve: #enable-push### Enable push (dbt.mdx:590), /docs/explore-analyze/analytics-chat exists, /embedding/iframe/dashboards#allow-csv-export still resolves because the heading kept its explicit {#allow-csv-export} anchor.
  • Keeping the old anchor while renaming the heading to Allow widget export is the right call — inbound links and the events.mdx <Note> survive. Worth an HTML comment next to it so a future cleanup doesn't "fix" the mismatch.
  • {#anchor} syntax matches existing usage on these pages (e.g. #### \cube:event:download` {#cube-event-download}`).
  • events.mdx is internally consistent: the format column already enumerated png/pdf, so dropping the "(in future)" hedge is correct, and rowCount staying scoped to csv/xlsx is right for image exports.
  • No frontmatter or docs.json nav changes needed — all four are edits to existing pages.
  • Scope discipline in the PR description (deferring the Funnel chart page, skipping two non-customer-facing changes) is sound.

Findings

# Severity File Issue
1 Medium docs/explore-analyze/workbooks/calculated-fields.mdx:109 New "NULL falls into the last bucket by default" contradicts the generated-SQL example at :135, which still shows WHEN ... IS NULL THEN 'Unknown' unconditionally.
2 Medium embedding/iframe/dashboards.mdx:95 Invents a Restrict data downloads "admin lock"; the documented control is the Allow data downloads switch in admin/users-and-permissions/roles-and-permissions.mdx#restricting-data-downloads. Suggested fix inline.
3 Low docs/explore-analyze/workbooks/calculated-fields.mdx:156 Menu-label conflict: line 149 still says Edit bins… / Edit groups…, the new section says the row menu offers Edit.
4 Low docs/integrations/dbt.mdx:664 Unspaced in a page that uses spaced throughout; new chat-driven push isn't linked from the page intro or the push <Info>.

Also noted inline: the <Frame> screenshot alt text on calculated-fields still describes the pre-rename bins panel, and the embedded PNG/PDF paragraph could cross-link /docs/explore-analyze/dashboards where the "up to a couple of minutes" server-render caveat already lives.

No prior review threads existed on this PR, so nothing to resolve or dedupe against. Docs-only change — no tests, build, or lint run.

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

bucket as `[10, 20)`, `>= 10 and < 20`, or `10 to 19`—the last is offered only while
every boundary is a whole number—or lets you type a **Custom** label per bucket.

By default, rows where the dimension is `NULL` fall into the last bucket. Turn on

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 new default contradicts the generated-SQL example further down. Line 135 still shows the Unknown branch as unconditional:

CASE WHEN orders_view.age IS NULL THEN 'Unknown'

but per this paragraph that branch only exists when Label empty values separately is on — the default now folds NULL into the last bucket (the ELSE arm). Either drop that first WHEN from the example, or add a half-sentence above the block noting the preview is shown with Label empty values separately enabled.

Same for the <Frame> alt text above ("a preview of the five buckets") — worth confirming the screenshot still matches the renamed Boundaries / Equal intervals tabs, since the panel UI changed.


Select a calculated field in the sidebar to open the editor. You can change its
**name** and **SQL expression**, then choose **Update** to apply.
Open a calculated field's menu—in the **Query fields** sidebar list, or from its

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.

This section and the paragraph at line 149 now describe the same action with different menu labels: line 149 says "choose Edit bins… or Edit groups… from its menu—either in the sidebar or on its column header", while this says the row menu offers Edit and a bins/groups field "reopens that panel". If the menu item is now uniformly Edit (as the PR description says), line 149 is stale and should either be updated or collapsed into this section — right now a reader looking for "Edit bins…" won't find it in the UI.

data already loaded into the widget; PNG and PDF are rendered server-side, so
they work even before the widget has finished loading in the browser. The
parameter is opt-in — omit it (the default) to keep the download actions
hidden. A tenant's **Restrict data downloads** admin lock, if enabled,

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 setting name doesn't match what's documented elsewhere. admin/users-and-permissions/roles-and-permissions.mdx#restricting-data-downloads calls it the Allow data downloads switch on Admin → Settings (turning it off hides export controls everywhere, "including admins and embeds") — there's no "Restrict data downloads" lock anywhere else in the docs. Suggest matching that name and linking, so the two pages stay in sync:

Suggested change
hidden. A tenant's **Restrict data downloads** admin lock, if enabled,
hidden. Turning off the account-wide **Allow data downloads** switch
([data download controls](/admin/users-and-permissions/roles-and-permissions#restricting-data-downloads))
overrides `allowExport` and hides all three actions regardless of the URL
parameter.

Two smaller things in this section:

  • /docs/explore-analyze/dashboards#download-a-dashboard-as-png-or-pdf already covers the server-rendered PNG/PDF behavior and warns it "can take up to a couple of minutes for large dashboards" — worth a cross-link here, since embedded viewers hit the same latency.
  • "so they work even before the widget has finished loading in the browser" reads as an inference from server-side; the tradeoff a reader actually needs is that it's slower and re-renders with your current filter/time-grain selections.


### Push a cube from Analytics Chat

Ask [the agent](/docs/explore-analyze/analytics-chat) to promote a cube to dbt, or to

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.

Content is accurate and the #enable-push / analytics-chat links resolve. Two style points:

  • Em dashes. This page uses spaced throughout (83 occurrences, including the sibling section at line 438); this new section uses unspaced five times ("yourself—for example", "conventions, then", "sandbox—iterating", "valid—before"). Worth normalizing to the page's style.
  • Discoverability. The intro at line 21 enumerates how pulls can be triggered and links #trigger-from-analytics-chat, and the <Info> at line 27 points to #push-cubes-to-dbt. Neither mentions that push can now be driven from chat too. A clause in the push <Info> (or in the Push a cube intro) linking here would surface it for readers who don't scroll the whole page.

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