docs: fill four small customer-facing doc gaps - #11593
Conversation
feat(cubesql) added support for `::regtype`/`::regtype[]` casts (#11503) to unblock BI-tool introspection queries, but the reference page for SQL functions and operators never got the corresponding entry.
Small multiples gained a second Split by picker (columns + rows, each independently capped at 5) in cubejs-enterprise#13860, but the reference page still said a single split dimension was the only option and that splitting by two dimensions at once was unsupported.
…ndicator The widget (and its Generate Summary/Re-run actions) was renamed to Analysis, with Run/Refresh actions and a freshness indicator replacing the old gear menu, per cubejs-enterprise#13915 and the in-app changelog. The docs page still used the old name and controls.
cubejs-enterprise#13897 extended the optional deploymentId parameter from chat/loadQueryResults to every other MCP tool (dashboard authoring, data model editing, query/discovery, pre-aggregations), and clarified how resuming a chat/visualize/loadQueryResults call derives its deployment from the existing thread. The docs only described the original three-tool behavior.
cubejs-enterprise#13893 made Can view access to a shared exploration actually read-only (editing/Save/Convert/Python/security-context hidden, SQL read-only). The sharing page defined Can view generically but never described what it looks like for an exploration.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @keydunov's task in 2m 23s —— View job Docs review: accurate overall — 0 high, 1 medium, 4 low. 3 inline comments posted.Full review
Verification performed
Navigation and cross-references are complete. FindingsMedium — Low — Low — Low — - - AI summary
+ - AnalysisLow / optional — Notes
|
| specific one on each request — every tool except `listDeployments` accepts an optional | ||
| **`deploymentId`**, and falls back to the deployment resolved at connect time when it's | ||
| omitted. |
There was a problem hiding this comment.
The blanket rule here is contradicted by the "Resuming a conversation" paragraph 20 lines down. This says every tool except listDeployments "falls back to the deployment resolved at connect time when it's omitted" — but for loadQueryResults, visualize, and chat with a chatId, an omitted deploymentId resolves from the thread, not from the connect-time default, and a supplied one can be rejected. A reader who stops at this paragraph will get the wrong model for exactly the tools most likely to surprise them.
Suggest forward-referencing the exception here:
| specific one on each request — every tool except `listDeployments` accepts an optional | |
| **`deploymentId`**, and falls back to the deployment resolved at connect time when it's | |
| omitted. | |
| specific one on each request — every tool except `listDeployments` accepts an optional | |
| **`deploymentId`**, and falls back to the deployment resolved at connect time when it's | |
| omitted (except when resuming an existing thread — see below). |
| ### How many panels are drawn | ||
|
|
||
| The grid bounds the render: a chart split into 3 × 2 draws at most six panels, so a high-cardinality dimension can never produce hundreds of unreadable ones. The largest grid is 5 × 5, or twenty-five panels. | ||
| Each axis is capped independently: **Columns** bounds the first dimension's values and, when a second dimension is set, **Rows** separately bounds the second dimension's values — so a 3-column × 2-row grid draws at most six panels. Since each axis clamps on its own, the largest grid is 5 × 5, or twenty-five panels, regardless of how many distinct values either dimension has. |
There was a problem hiding this comment.
"the largest grid is 5 × 5, or twenty-five panels" is stated unconditionally, but per the Options table Rows is only shown once a Second dimension is chosen. So with a single split dimension the ceiling is 5 panels (Columns alone), not 25 — the 25-panel maximum is reachable only in the two-dimension case. Worth qualifying so a reader with one dimension doesn't expect to be able to draw 25 panels.
| The widget keeps a checksum of the dashboard state at the time of generation: the queries behind each chart, the active control values, and the chart configuration. When any of those change, the widget marks the cached summary as **stale** and shows a refresh prompt so viewers know the narrative may no longer match the data. | ||
|
|
||
| Click the refresh icon (or open the widget menu and choose **Refresh**) to regenerate using the saved prompt against the latest state. | ||
| On a published dashboard, a widget that has run shows a freshness indicator instead of a menu — colored by how old the data is, with a tooltip reading "Refreshed *N* ago". Open it and choose **Refresh** to regenerate using the saved prompt against the latest state. The dashboard's **Refresh all charts** control also refreshes any Analysis widget that has already run at least once. |
There was a problem hiding this comment.
Two small issues with this replacement:
- "shows a freshness indicator instead of a menu" reads as a contradiction with the very next sentence — "Open it and choose Refresh" describes opening a menu. Probably meant "instead of the gear menu" / "in place of the widget menu".
- The removed sentence was the only place describing how to refresh at all; this one scopes itself to "On a published dashboard". Refreshing from the dashboard builder (where the prompt editor lives, and where you'd most often iterate) is now undocumented.
Check List
Description of Changes Made
Found while auditing recent cube-js/cube and cubejs-enterprise changes against docs-mintlify for undocumented customer-facing behavior:
::regtype/::regtype[]cast support (feat(cubesql): Supportregtypeandregtype[]casts #11503), which shipped with no doc update.deploymentIdis now accepted by every tool, not justchat/loadQueryResults, and how resuming a chat/visualize/loadQueryResults call derives its deployment from the existing thread (cubejs-enterprise#13897).Can viewaccess looks like for a shared exploration now that it's genuinely read-only (cubejs-enterprise#13893).No functional/code changes — docs-mintlify only.
Generated by Claude Code