docs: document embed header controls and standalone explorations - #11673
Conversation
- Add URL parameters for hiding individual embedded-dashboard header controls (title, back button, edit, duplicate, or the whole bar), with a pointer from the Creator Mode page. - Clarify that a saved item without a workbook is a standalone exploration (the same object as a workbook report, just unfiled), documented consistently across Analytics Chat, Explore, Workbooks, Python analysis, and the MCP server's createReport tool.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @vasilev-alex's task in 2m 37s —— View job Docs review — no blockers; 2 medium, 3 low, all inlineFull review — findings, verification notes, and checklistTodo
Verified clean
Findings
Could not verifyEvery behavioral claim in this PR — the five URL parameters and their defaults, the Edit-permission precedence rule, parameters surviving in-app navigation, I also did not run the Mintlify build or a link checker (no Adjacent, pre-existing — out of scope
|
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
- Simplify the allowExport comparison and drop CSS-level detail in favor of the actual precedence rule between showDashboardHeader and the per-control parameters. - Call out that the header-control parameters are URL-only, not part of the Generate Session settings object, with a matching pointer from the API reference. - Remove a claim that a saved Python analysis can be opened in Excel or Google Sheets — the add-ins render a report's raw SQL result, not a Python script's output, so that combination doesn't work. - Trim a features-list bullet that had grown a how-to prompt inside it.
|
Claude finished @vasilev-alex's task in 1m 8s —— View job Re-review after
|
| # | Prior issue | Now |
|---|---|---|
| 1 | python-analysis.mdx — unverified Excel/Sheets claim + "exploration"/"report" mixed in one sentence |
Excel/Sheets clause dropped; sentence rewritten to "persists both the code and the run result" without re-introducing "report" ✅ |
| 2 | allowExport "fails closed" framing + design-intent wording |
Replaced with a plain parsing comparison — and it matches dashboards.mdx:93-95, which does say only the literal true opts in ✅ |
| 3 | CSS trivia ("no empty row or stray border") + unspecified showDashboardHeader interaction |
Trivia dropped; precedence now stated explicitly: showDashboardHeader=false overrides the other four ✅ |
| 4 | showDashboard* prefix collision with the settings key showDashboardChat |
Fixed on both sides — a <Note> directly under the table, plus a reciprocal note at generate-session.mdx:82 ✅ |
| 5 | Over-long Analytics Chat bullet with an embedded prompt string | Trimmed to sibling length ✅ |
The five prior threads are already resolved, so nothing to clean up.
Verified
- Anchors resolve.
#show-or-hide-header-controlsand#show-or-hide-the-ai-chat→dashboards.mdx:132/:102;#session-settings→generate-session.mdx:63;#saving-explorations→explore.mdx:50;#allow-csv-exportunchanged. - The
allowExportcomparison is internally accurate — I checked the target section rather than taking it on trust. - Two new
<Note>s + the precedence paragraph are the right additions; the section now answers the three questions a reader actually arrives with (what parses as false, what wins, where can I set it). - Docs land in
/docs-mintlifyonly; nodocs.jsonchange needed (no new pages).
Remaining — 1 low, posted inline
analytics-chat.mdx:16 — the Python bullet still reads "save it to a workbook as a re-runnable report" while the bullet three lines below (and python-analysis.mdx:35) now offer workbook-or-standalone. Last leftover of the terminology pass. Suggestion posted.
Also noted, not blocking: the section's second <Note> partly restates the first (both touch the settings-object / account-wide distinction). Readable as-is.
Still unverifiable here
Same caveat as the first pass: the five URL parameters, their defaults, the Edit-permission precedence, the parameters surviving in-app navigation, and createReport's optional workbookId all describe Cube Cloud, which isn't in this repo. The newly added claim that showDashboardHeader=false overrides the other four is a behavioral assertion I can't check either — it's the one I'd have an author confirm. I validated internal consistency and links by reading targets; no Mintlify build or link checker was run (no yarn install in this environment).
…erminology Same list on the same page already said saved results can be a report or a standalone exploration; the Python bullet still said "workbook" only.
|
Claude finished @vasilev-alex's task in 1m 29s —— View job Re-review after 2 new commits — no blockers; 2 low, both inlineFull review — what changed, verification notes, and checklistTodo
Prior round: all five threads addressed
Verified clean this round
Findings
Both are wording-level. Neither blocks merge. Could not verifyUnchanged from last round: every behavioral claim here — the five URL parameters and their defaults, I did not run the Mintlify build or a link checker (no |
|
Claude Code is working… I'll analyze this and get back to you. |
|
Claude finished @vasilev-alex's task in 1m 1s —— View job Re-review after
|
| Prior issue | Now |
|---|---|
python-analysis.mdx — dangling which after "the run result" |
a278c1e splits the sentence: "…persists both the code and the run result. Opening the saved copy renders that output without re-running; saving re-executes the analysis." Antecedent is explicit ✅ |
dashboards.mdx — two <Note>s 15 lines apart both contrasting with showDashboardChat |
4bbba81 folds them into one: the account-wide-default clause moved into the first Note, the scope clause into the prose paragraph, second Note deleted. Says it once ✅ |
All eight review threads on this PR are resolved; nothing to re-affirm and nothing stale to clean up.
Verified this round
- Anchors still resolve after the callout move:
#show-or-hide-header-controls(dashboards.mdx:130) and#show-or-hide-the-ai-chat(:101),#session-settings(generate-session.mdx:63),#saving-explorations(explore.mdx:50). The deleted<Note>was the only inbound use of#show-or-hide-the-ai-chatfrom within that section, and the remaining reference fromcreator-mode.mdxis unaffected. - The
allowExportinverse-polarity comparison is accurate — checked againstdashboards.mdx:91-93, which does say only the literaltrueopts in. - Terminology holds end to end. Both
analytics-chat.mdxbullets,python-analysis.mdx:35,workbooks/index.mdx:9,explore.mdx:52, and thecreateReportrow (mcp-server.mdx:262) now describe one object with one mechanism — "omitworkbookId" / "leaving the workbook unset". That was the point of the PR and it lands. - Cross-link is bidirectional:
generate-session.mdx:82→ the URL-parameter section,dashboards.mdx:157→settings. A reader entering from either side gets redirected correctly. - Right tree, no nav change needed — all eight files under
/docs-mintlify, no new pages, sodocs.jsoncorrectly untouched.
Finding
| # | Sev | File | Issue |
|---|---|---|---|
| 1 | Low | dashboards.mdx:165 |
Fallout from my own merge suggestion: "They apply to the dashboard header only" follows a sentence whose subject is the singular showDashboardEditButton, so the plural pronoun has to skip past it. Suggested naming the subject and moving the scope sentence ahead of the two precedence rules. |
Wording-level only; does not block merge.
Could not verify
Unchanged across all three passes: the five URL parameters and their defaults, showDashboardHeader=false winning over the other four, the Edit-permission precedence, the parameters surviving in-app navigation, and createReport's optional workbookId all describe Cube Cloud, which isn't in this repo (grep for showDashboard/createReport across packages/ and rust/ returns nothing). I checked internal consistency and link integrity only. The author confirmed the Excel/Sheets behavior against the add-in code in round two; the rest still rests on author knowledge.
No Mintlify build or link checker was run (no yarn install in this environment) — link validation was done by reading each target file.
|
Claude finished @vasilev-alex's task in 51s —— View job Re-review after
|
| Prior issue | Now |
|---|---|
dashboards.mdx — "They apply to the dashboard header only" reaching past the singular showDashboardEditButton |
0f4272f moves the scope sentence to its own paragraph ahead of the precedence rules and names its subject: "These parameters apply to the dashboard header only…". The two precedence rules (showDashboardHeader wins; showDashboardEditButton can only hide) are now adjacent in one paragraph ✅ |
All nine review threads on this PR are resolved. Nothing stale to clean up, nothing to re-affirm, and no new inline comments this round.
Verified this round
- Every anchor resolves.
#saving-explorations→explore.mdx:50;#show-or-hide-header-controls→dashboards.mdx:132;#allow-csv-export→ the explicit{#allow-csv-export}slug atdashboards.mdx:80;#session-settings→generate-session.mdx:63. - The
allowExportinverse-polarity claim is accurate —dashboards.mdx:93-95does say only the literaltrueopts in, and lists the same shapes (=1,=TRUE, bare param) that the new paragraph mirrors forfalse. The comparison holds in both directions. - Cross-links are bidirectional and complete:
generate-session.mdx:82→ the URL-parameter section;dashboards.mdx:155→settings;creator-mode.mdx:18→ the same section. A reader arriving from the API reference, the Creator Mode page, or the dashboards page all land correctly. - Terminology is consistent end to end. Both
analytics-chat.mdxbullets,python-analysis.mdx:35,workbooks/index.mdx:9,explore.mdx:52, and thecreateReportrow (mcp-server.mdx:262) now describe one object with one mechanism — "omitworkbookId" / "leaving the workbook unset". That was the PR's stated goal and it lands. - Right tree, no nav change needed — all eight files under
/docs-mintlify, no new pages, sodocs.jsonis correctly untouched. - Section reads in the order a reader needs it: table → example URL → parsing rule → how-you-pass-it callout → scope → precedence → lifetime.
Only nit left is cosmetic and I'm not filing it: three consecutive paragraphs in the new section open with "These parameters" / "Every one of these". Readable as-is.
Could not verify
Unchanged across all four passes: the five URL parameters and their defaults, showDashboardHeader=false winning over the other four, the Edit-permission precedence, the parameters surviving in-app navigation, and createReport's optional workbookId all describe Cube Cloud, which isn't in this repo (grep for showDashboard/createReport across packages/ and rust/ returns nothing). I checked internal consistency and link integrity only; accuracy of the behavior rests on author knowledge. The author did confirm the Excel/Sheets add-in behavior against the add-in code in round two, which is the one claim that got independently checked.
No Mintlify build or link checker was run (no yarn install in this environment) — link validation was done by reading each target file.
2 participants
Check List
Description of changes
Two independent documentation updates:
createReporttool docs, instead of leaving the two terms used inconsistently.Both changes are surgical edits to existing sections — no new pages or navigation entries.
Generated by Claude Code