docs: fix five stale documentation sections - #11671
Conversation
|
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 1m 38s —— View job Docs review — 1 medium, 2 low. Otherwise accurate and well-scoped; anchors and cross-links check out.Full review
FindingsMedium — wording inverts the meaning of Low — undefined jargon ( Low — tab reference may be inconsistent ( Verified as correct
Notes, non-blocking
No security, performance, or test-coverage surface in this change — it's docs-only content. |
- default_ui_filters now seed queries in the Google Sheets / Excel add-in as well as workbooks and React Embed SDK views - document one exploration placed on many sheets/workbooks in the Excel/Sheets add-ins - document the measure position and order controls in the Excel/Sheets pivot builder - document runQuery's branchName parameter and the branch-verification step in the MCP server workflow - allowExport in embedded dashboards now covers PNG/PDF, not just CSV
c0735cf to
fe41f57
Compare
|
Claude finished @vasilev-alex's task in 1m 17s —— View job Docs review — no new commits since my last pass; 3 prior threads still apply, 1 new low finding.Full review
State of the branchThe synchronize event didn't bring new content — the branch is still at a single commit (
Re-affirmed those three rather than re-posting them. New finding this passLow — self-contradicting sentence (
The first clause says the placement breaks on insertion; the second says the anchor tracks the sheet — the opposite reading. As written a user can't predict what happens when they insert a row above a report. Inline comment posted with a suggested direction. Verified as correct on this pass
Notes, non-blocking
Docs-only change — no security, performance, or test-coverage surface. |
- allowExport: replace the confusing "opt-in ... otherwise opt-out" framing with a plain list of what stays hidden - saved reports: clarify that an anchor is a fixed cell reference, so row/column inserts above it break the placement instead of shifting with it
|
Claude finished @vasilev-alex's task in 1m 5s —— View job Docs review — new commit
|
| Prior thread | Status |
|---|---|
dashboards.mdx:94 — "otherwise opt-out" inverted the meaning |
Fixed. Replaced with a concrete enumeration: "allowExport=1, allowExport=TRUE, a bare ?allowExport, and omitting the parameter (the default) all leave every download action hidden." Strictly better than my suggested opt-in phrasing — it tells the reader what the non-opting values actually are. |
dashboards.mdx:98 — undefined "Screenshot mode" jargon |
Fixed. Sentence dropped. |
google-sheets.mdx:154 / microsoft-excel.mdx:162 — self-contradicting anchor sentence |
Fixed. Now: "the visible data shifts down with the insert, but the stored anchor doesn't move with it, so the next refresh targets the wrong cell." States the mechanism and the observable consequence — a reader can predict the outcome. |
google-sheets.mdx missing trailing newline (non-blocking nit) |
Fixed. |
The Display vs Pivot tab thread (google-sheets.mdx:130) was resolved without a text change. That's the author's call on a UI detail I can't verify from this repo — not re-raising it.
Verified on this pass
- Anchor preservation intact:
## Allow chart export {#allow-csv-export}(dashboards.mdx:80) still matches the inbound linkevents.mdx:214→/embedding/iframe/dashboards#allow-csv-export. No other reference to the old anchor exists. - The Excel and Sheets rewrites stayed in sync — identical structure, correct spreadsheet/workbook swap per page.
- The rest of the diff (
mcp-server.mdxbranchName,view.mdxdefault_ui_filterssurface list,events.mdxPNG/PDF,querying-data.mdxpointer) is unchanged from my prior pass, which found it accurate and internally consistent.
Notes, non-blocking
dashboards.mdx:97— "The CSV is generated client-side from the data already loaded into the widget, so no additional query is issued." The section now covers three formats, so this leaves PNG/PDF generation unaddressed. A half-clause ("PNG and PDF render the widget as displayed") would close the gap if that's accurate.{#allow-csv-export}under a heading titled "Allow chart export" remains a small future trap for the next editor. Correct choice for this PR — adocs.jsonredirect plus a renamed anchor is the tidier long-term shape.
Docs-only change — no security, performance, or test-coverage surface.
Check List
Fixes five places where the docs described stale or incomplete behavior:
default_ui_filterson a view now also seed queries in the Google Sheets / Excel add-in, not just workbooks and views embedded via the React Embed SDK. Updated the surface list inreference/data-modeling/view.mdx, added a pointer on the workbooks querying-data page, and a short note on both add-in pages.runQuerytool now accepts an optionalbranchName, so an agent editing the data model can verify a change against its own dev branch before merging. Updated the tool table, the safety-constraints list, and the edit-the-data-model walkthrough indocs/integrations/mcp-server.mdx.allowExport=truenow also unlocks PNG/PDF widget export, not just CSV. Renamed and rewrote the "Allow CSV export" section inembedding/iframe/dashboards.mdx(kept the old anchor via explicit{#allow-csv-export}syntax so the existing inbound link fromevents.mdxkeeps working), and updated thecube:event:downloaddocs, which still said PNG was "in future."Also fixed a small pre-existing typo while in the area ("Google Cloud for Sheets" → "Cube Cloud for Sheets" in
google-sheets.mdx, matching the equivalent sentence on the Excel page).Ran
npx mintlify broken-links --check-anchors— no new broken links (one pre-existing broken anchor inreference/control-plane-api.mdxis unrelated to this change).