Skip to content

docs: fix five stale documentation sections - #11671

Merged
vasilev-alex merged 2 commits into
masterfrom
claude/bold-turing-z9d9zp
Aug 27, 2026
Merged

docs: fix five stale documentation sections#11671
vasilev-alex merged 2 commits into
masterfrom
claude/bold-turing-z9d9zp

Conversation

@vasilev-alex

@vasilev-alex vasilev-alex commented Aug 27, 2026

Copy link
Copy Markdown
Member

Check List

  • Docs have been added / updated if required
  • N/A — Tests / linter (docs-only change)

Fixes five places where the docs described stale or incomplete behavior:

  • default_ui_filters on 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 in reference/data-modeling/view.mdx, added a pointer on the workbooks querying-data page, and a short note on both add-in pages.
  • Excel/Sheets add-in — saved reports. An exploration can now be placed on multiple sheets/anchors and in multiple documents (a Google Sheets spreadsheet and an Excel workbook) at once. Rewrote "Work with saved reports" on both add-in pages to describe placements and what Refresh actually updates, instead of a single report location.
  • Excel/Sheets add-in — pivot builder. The pivot builder's Display tab now has a Measure position control (before/after the paired dimension, on both the Columns and Rows axes) plus drag-to-reorder within the Measures pane. Added a "Measure position and order" subsection to both add-in pages with a worked before/after example.
  • Cube MCP server. The runQuery tool now accepts an optional branchName, 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 in docs/integrations/mcp-server.mdx.
  • Embedded dashboards. allowExport=true now also unlocks PNG/PDF widget export, not just CSV. Renamed and rewrote the "Allow CSV export" section in embedding/iframe/dashboards.mdx (kept the old anchor via explicit {#allow-csv-export} syntax so the existing inbound link from events.mdx keeps working), and updated the cube:event:download docs, 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 in reference/control-plane-api.mdx is unrelated to this change).

@vasilev-alex
vasilev-alex requested a review from keydunov as a code owner August 27, 2026 19:06
@mintlify

mintlify Bot commented Aug 27, 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 27, 2026, 7:07 PM

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

@claude

claude Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

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
  • Read PR diff (git diff origin/master...HEAD)
  • Check cross-references / anchors resolve
  • Check wording & internal consistency
  • Post review

Findings

Medium — wording inverts the meaning of allowExport (embedding/iframe/dashboards.mdx:94)
"Only the exact literal string true opts in; the parameter is otherwise opt-out" contradicts the clause that follows it and the pre-PR text ("The parameter is opt-in"). A reader could take away that omitting allowExport leaves downloads enabled. Inline suggestion posted.

Low — undefined jargon (embedding/iframe/dashboards.mdx:98)
"Screenshot mode suppresses export regardless of the parameter" — "Screenshot mode" appears nowhere else in docs-mintlify, so an embedding reader can't act on it. Either define it in embed terms or drop the sentence.

Low — tab reference may be inconsistent (docs/integrations/google-sheets.mdx:130, mirrored at microsoft-excel.mdx:138)
Measure position / Measures on are placed on the Display tab, but drag-to-reorder is described as the Measures pane on the Pivot tab, while the PR description implies both are on Display. Worth a second look at QueryBuilder.tsx.

Verified as correct

  • Anchor preservation works: ## Allow chart export {#allow-csv-export} keeps the inbound link from events.mdx:214 alive. Explicit-anchor syntax is supported by Mintlify and the repo pattern is consistent with other {#…} headings.
  • [ref-default-ui-filters]: /reference/data-modeling/view#default_ui_filters resolves — the heading #### \default_ui_filters` exists (view.mdx:287) and the same link form is already used in querying-data.mdx:432`.
  • events.mdx format table already listed png/pdf, so removing "(in future)" makes the prose match the table rather than introducing a new claim.
  • {/* TODO: screenshot — … */} placeholders match an established convention in this repo (table.mdx, kpi.mdx, python-analysis.mdx), so they're not blocking.
  • Google Sheets / Excel text is intentionally near-duplicated, consistent with how those two pages already track each other; the spreadsheet/workbook wording is correctly swapped per page.
  • Scope calls in the description (skipping the api.yaml regeneration, holding CUB-4188/4186/4181) look right — regenerating a fully generated file with ~2k lines of unrelated drift doesn't belong in a docs-copy PR.

Notes, non-blocking

  • google-sheets.mdx still ends without a trailing newline (pre-existing, the added link line just inherits it). Cheap to fix while in the file.
  • The kept #allow-csv-export anchor under a heading now titled "Allow chart export" is a small future trap for anyone editing the section. Fine as-is; a docs.json redirect plus a renamed anchor would be the tidier long-term shape.

No security, performance, or test-coverage surface in this change — it's docs-only content.

· branch `claude/bold-turing-z9d9zp`

Comment thread docs-mintlify/embedding/iframe/dashboards.mdx Outdated
Comment thread docs-mintlify/embedding/iframe/dashboards.mdx Outdated
Comment thread docs-mintlify/docs/integrations/google-sheets.mdx
- 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
@vasilev-alex
vasilev-alex force-pushed the claude/bold-turing-z9d9zp branch from c0735cf to fe41f57 Compare August 27, 2026 19:57
@vasilev-alex vasilev-alex changed the title docs: five safe-to-merge doc fixes from Linear Docs backlog docs: fix five stale documentation sections Aug 27, 2026
@claude

claude Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

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
  • Read PR diff (git diff origin/master...HEAD)
  • Reconcile with prior review threads
  • Check cross-references / anchors
  • Post review

State of the branch

The synchronize event didn't bring new content — the branch is still at a single commit (fe41f57), identical to what I reviewed before. So all three of my earlier threads are unresolved and still accurate against the current file contents:

File:line Concern
embedding/iframe/dashboards.mdx:94 "the parameter is otherwise opt-out" still contradicts the clause that follows it and the pre-PR text. Medium — a reader could conclude omitting allowExport leaves downloads on.
embedding/iframe/dashboards.mdx:98 "Screenshot mode" is still undefined anywhere in docs-mintlify. Low.
docs/integrations/google-sheets.mdx:130 (mirrored microsoft-excel.mdx:138) Measure position / Measures on on the Display tab vs drag-to-reorder in the Measures pane on the Pivot tab — still worth confirming against QueryBuilder.tsx. Low.

Re-affirmed those three rather than re-posting them.

New finding this pass

Low — self-contradicting sentence (docs/integrations/google-sheets.mdx:154, mirrored microsoft-excel.mdx:162)

It does not survive rows or columns inserted above its anchor cell; the anchor still shifts with the sheet.

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

  • Anchor preservation holds: ## Allow chart export {#allow-csv-export} keeps the inbound link from events.mdx:214 alive.
  • [ref-default-ui-filters]: /reference/data-modeling/view#default_ui_filters resolves on all three pages that now reference it (view.mdx:287 heading exists).
  • events.mdx format table already listed png/pdf, so dropping "(in future)" aligns prose with the existing table rather than asserting anything new.
  • mcp-server.mdx additions are internally consistent: the runQuery table row, the safety-constraints bullet, and the edit walkthrough all describe the same branchName semantics (fail loudly on a non-dev branch, omit → deployed model), and the tool stays correctly marked Read-only.
  • view.mdx rewording of the default_filters contrast correctly generalizes "workbook UI" → "starting point" / "data consumers" now that three surfaces are in scope.
  • Google Sheets ↔ Excel near-duplication is intentional and the spreadsheet/workbook wording is swapped correctly per page.
  • Scope calls (skipping the generated api.yaml, holding CUB-4188/4186/4181) still look right.

Notes, non-blocking

  • google-sheets.mdx still ends without a trailing newline (pre-existing).
  • The saved-reports rewrite drops the Edit button reference in favor of "click its title to open it" — fine if that matches the shipped UI, just noting the affordance name changed.
  • {#allow-csv-export} under a heading now titled "Allow chart export" remains a small future trap; a docs.json redirect would be the tidier long-term shape.

Docs-only change — no security, performance, or test-coverage surface.

· branch `claude/bold-turing-z9d9zp`

Comment thread docs-mintlify/docs/integrations/google-sheets.mdx Outdated
- 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

claude Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Claude finished @vasilev-alex's task in 1m 5s —— View job


Docs review — new commit f18bc27 resolves both blocking threads; no new findings. Looks ready.

Full review
  • Read new commit f18bc27
  • Reconcile prior review threads
  • Check cross-references & anchors
  • Post review

What changed since the last pass

f18bc27 addresses the two wording defects I raised, and fixes the trailing-newline nit:

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 link events.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.mdx branchName, view.mdx default_ui_filters surface list, events.mdx PNG/PDF, querying-data.mdx pointer) 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 — a docs.json redirect plus a renamed anchor is the tidier long-term shape.

Docs-only change — no security, performance, or test-coverage surface.

· branch `claude/bold-turing-z9d9zp`

@vasilev-alex
vasilev-alex merged commit 2ac3388 into master Aug 27, 2026
32 checks passed
@vasilev-alex
vasilev-alex deleted the claude/bold-turing-z9d9zp branch August 27, 2026 20:08
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