Skip to content

docs: add Dashboard Agent and Workbook Agent pages#10973

Merged
keydunov merged 1 commit into
masterfrom
docs/dashboard-agent
May 29, 2026
Merged

docs: add Dashboard Agent and Workbook Agent pages#10973
keydunov merged 1 commit into
masterfrom
docs/dashboard-agent

Conversation

@keydunov
Copy link
Copy Markdown
Member

Summary

Adds end-user documentation for Cube Cloud's conversational AI assistants, aimed at dashboard viewers and workbook authors (analysts/business users), not platform engineers.

  • Dashboard Agent (docs/explore-analyze/dashboards/dashboard-agent) — the read-only Q&A panel docked on published/embedded dashboards. Covers opening the panel, focusing on a specific chart, what it can/can't do, attachments, and limitations.
  • Workbook Agent (docs/explore-analyze/workbooks/workbook-agent) — the in-workbook authoring assistant (creating reports, building/editing/publishing dashboards). Includes a note distinguishing it from Analytics Chat.
  • Wires both pages into the explore-analyze navigation in docs.json.

The two surfaces are kept clearly separated: published Dashboard Agent is read-only; the Workbook Agent does authoring.

Reviewer notes

  • Behavior is written from a product brief, not verified against the running app or the (private) Cube Cloud source. Please sanity-check UI labels and behavior before merge — in particular the chart-tile "Ask a follow up question" action, attached-chart chips, and the read-only follow-up query flow, which are marked "rolling out" in the doc since I couldn't confirm they've merged.
  • Clipboard-image paste is flagged as "confirm before relying on it" rather than asserted.
  • The read-only-filters limitation is described as "actively being worked on" (no internal tracking reference included).
  • The Dashboard Agent screenshot currently points at an external ucarecdn URL; consider rehosting on static.cube.dev for consistency with other docs images.

Test plan

  • cd docs-mintlify && yarn dev and verify both pages render
  • Confirm both pages appear in the left nav under Present & Share → Dashboards and Workbooks
  • Verify all cross-links resolve (Dashboard Agent ↔ Workbook Agent, Analytics Chat)
  • Confirm screenshot loads

🤖 Generated with Claude Code

Document the conversational AI assistants for end users (dashboard
viewers and workbook authors). The Dashboard Agent page covers the
read-only Q&A panel on published/embedded dashboards; the Workbook
Agent page covers in-workbook authoring. Wires both into the
explore-analyze navigation.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 29, 2026

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


Code Review

Docs-only PR adding two end-user pages and wiring them into nav. Overall the writing is clear, the read-only vs. authoring split is well-drawn, and cross-links resolve.

Verdict: 1 high (broken-looking screenshot URL), 0 medium, 1 low. Otherwise good to merge once the asset is rehosted.

Details
  • Read both new pages and the docs.json diff
  • Verify referenced pages exist (analytics-chat.mdx, workbooks/index.mdx, dashboards/index.mdx, etc.) — all present
  • Check nav wiring in docs.json — both pages registered under the right groups
  • Post inline findings

Findings

High — screenshot URL looks malformed (docs-mintlify/docs/explore-analyze/dashboards/dashboard-agent.mdx:18)
The src is https://lgo0ecceic.ucarecd.net/.... Uploadcare's CDN is ucarecdn.com, not ucarecd.net with a per-account subdomain — this almost certainly 404s. The PR description already flags rehosting on static.cube.dev; please do that before merge so the only image on the page actually loads. Inline comment posted.

Low — "Report search covers published reports only" on the Dashboard Agent page (dashboard-agent.mdx:110-111)
This bullet appears under "Limitations" on the Dashboard Agent page, but the surrounding copy emphasizes that the Dashboard Agent is read-only and explicitly can't create reports or workbooks. A reader may wonder why report search is mentioned at all here — is the Dashboard Agent expected to search for reports across the workspace from a published dashboard? If yes, that capability isn't introduced anywhere else on the page; if no, the bullet probably belongs only on the Workbook Agent page (where the same line already appears at workbook-agent.mdx:49-50). Worth either adding a one-line "the agent can point you to related published reports" mention in the "It can" list, or dropping the bullet here.

Nits (non-blocking)

  • dashboard-agent.mdx:18 — the <img> has no closing /> on its own line; works fine in MDX but other docs in the repo tend to one-line the <img> tag. Stylistic only.
  • workbook-agent.mdx has no screenshot. Not required, but a single hero image would match the Dashboard Agent page's shape.

What looks good

  • Clear, repeated framing of "read-only vs. authoring" — the <Note> blocks on both pages reinforce it without being redundant.
  • Honest hedging on unreleased UI (chart-tile follow-ups, clipboard paste) with explicit "rolling out" / "confirm before relying on it" callouts — prevents the docs from making promises ahead of the product.
  • Cross-links between Dashboard Agent ↔ Workbook Agent ↔ Analytics Chat all resolve to existing files.
  • Nav placement in docs.json is consistent with neighboring entries.
• Branch: `docs/dashboard-agent`


<Frame>
<img
src="https://lgo0ecceic.ucarecd.net/a50f87dd-126d-44ad-87e9-6c9a0af81c1a/"
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 host lgo0ecceic.ucarecd.net looks malformed — Uploadcare's CDN is ucarecdn.com, not ucarecd.net with a per-account subdomain. This URL is very likely broken (and the PR description itself flags rehosting). Recommend uploading the asset to static.cube.dev for consistency with the rest of the docs and swapping the src before merge.

@keydunov keydunov merged commit 69c9cb0 into master May 29, 2026
17 of 18 checks passed
@keydunov keydunov deleted the docs/dashboard-agent branch May 29, 2026 20:08
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 29, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🔴 Failed May 29, 2026, 8:13 PM

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

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.

1 participant