Skip to content

docs: document default dashboards for embed Creator Mode#10946

Merged
vasilev-alex merged 1 commit into
masterfrom
docs/cub-2718-default-dashboards
May 27, 2026
Merged

docs: document default dashboards for embed Creator Mode#10946
vasilev-alex merged 1 commit into
masterfrom
docs/cub-2718-default-dashboards

Conversation

@vasilev-alex
Copy link
Copy Markdown
Member

Summary

Documents the CUB-2540 "starter dashboards" feature (Linear: CUB-2718) in docs-mintlify.

Adds a Default dashboards section to the Creator Mode embedding page covering:

  • What default dashboards are and why to use them (pre-populate embed users' workspaces instead of an empty start).
  • The mechanism: share main-workspace content (read-only) with the auto-created All embed users (all_embed_users) system group.
  • A 3-step setup flow.
  • The system group's constraints (can't rename/delete, view-only, appears once Creator Mode is enabled).
  • Behavior notes: folder-share cascades; single-item share exposes ancestor folders only; same set across embed tenants; shared workbooks open their published dashboard; removing the share takes effect immediately.

Notes

  • Public-facing term is "Default dashboards" (we avoided the internal "seed/starter" wording, which was flagged as confusing). The internal slug all_embed_users is shown in parentheses for reference.
  • Section only — no docs.json nav change needed.
  • Scope limited to docs-mintlify/ per the issue guidance.

Follow-ups

  • A screenshot of the share dialog showing All embed users would strengthen the section.
  • Worth confirming the "shared workbook requires a published dashboard to open" detail against live behavior before merge.

🤖 Generated with Claude Code

Add a "Default dashboards" section to the Creator Mode embedding page
describing how admins share main-workspace content (read-only) with the
auto-created "All embed users" (all_embed_users) system group so embed
users see starter content immediately.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vasilev-alex vasilev-alex requested a review from keydunov as a code owner May 27, 2026 02:37
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 27, 2026

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

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview May 27, 2026, 2:38 AM

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

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 27, 2026

Claude finished @vasilev-alex's task in 59s —— View job


Code Review: Documentation for Default Dashboards

  • Gather context and read changed files
  • Review documentation content for accuracy and clarity
  • Check formatting and consistency with existing page
  • Post review feedback

Overall: This is a clean, well-structured documentation addition. The writing is clear, the section fits naturally into the existing page, and the behavior notes cover the important edge cases. A few minor suggestions below.

Feedback

1. Consider a cross-reference back from the User Groups page

The user-groups.mdx page doesn't mention the All embed users system group at all. Since this is a system-created group that appears in Admin → User Groups, users navigating from that page might not know it exists or what it's for. A brief mention or link back to the Creator Mode page would help discoverability. This could be a follow-up.

2. Section placement is good

The new section sits between "Provisioning groups and user attributes" and the "Example" code block — this is a logical location. Default dashboards are a setup concept that belongs before the code example. No issue here.

3. Minor wording nit (line 50)

All embed users see the **same** default dashboards, regardless of their groups or user attributes. The shared set applies across every embed tenant that belongs to your account.

The phrase "every embed tenant that belongs to your account" could be slightly ambiguous — does "account" mean the Cube Cloud account/organization, or a specific deployment? If it means organization-wide across deployments, that's worth clarifying. If it's per-deployment (which seems more likely given deploymentId in the example), consider: "…across every embed tenant within the deployment."

Fix this →

4. "Published dashboard" requirement deserves emphasis (line 51)

Opening a shared workbook shows its published dashboard, so a workbook must have a published dashboard for users to open it.

This is a potential gotcha — if a workbook doesn't have a published dashboard, what happens? Does the user see an error, an empty state, or is the item simply hidden? Clarifying the failure mode would help users avoid confusion. The PR description itself flags this as needing verification against live behavior, which is prudent.

5. No docs.json nav change needed — confirmed

The page is already in the nav config at line 419 of docs.json, and since this is a new section within an existing page (not a new page), no navigation update is needed. Confirmed.

6. Follow-up items from the PR description are worth tracking

The PR description mentions two follow-ups:

  • A screenshot of the share dialog showing All embed users
  • Verifying the "shared workbook requires a published dashboard" detail

Both are valid — especially the second one, since documenting incorrect behavior would cause user confusion. I'd recommend verifying that detail before merging if possible.

Summary

This is a solid docs addition — well-written, correctly scoped, and placed logically. The two items I'd consider addressing before merge are: (1) clarifying "account" vs "deployment" scope on line 50, and (2) confirming the published-dashboard requirement on line 51 against live behavior. Everything else looks good to ship.

@vasilev-alex vasilev-alex merged commit d1db651 into master May 27, 2026
12 checks passed
@vasilev-alex vasilev-alex deleted the docs/cub-2718-default-dashboards branch May 27, 2026 14:14
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