Skip to content

docs: cover dashboard-embed toggle API, dev-mode branch writes, devmode deep link, email unsubscribe#11357

Open
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-ae69ly
Open

docs: cover dashboard-embed toggle API, dev-mode branch writes, devmode deep link, email unsubscribe#11357
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-ae69ly

Conversation

@keydunov

Copy link
Copy Markdown
Member

Check List

  • Docs have been added / updated if required
  • Tests have been run in packages where changes have been made if available (N/A — docs only)
  • Linter has been run for changed code (N/A — docs only)
  • Tests for the changes have been added if not covered yet (N/A — docs only)

Description of Changes Made

Routine sweep of recent cube-js/cube and cubedevinc/cubejs-enterprise changes against docs-mintlify turned up a few small customer-facing gaps:

  • PATCH /v1/embed/dashboard/{publicId} — new admin-only Control Plane API endpoint to enable/disable signed embedding for a dashboard (cubejs-enterprise #13274), paired with the new cube embed enable-dashboard/disable-dashboard CLI commands (feat(cube-cli): add embed enable-dashboard / disable-dashboard commands #11356). Added the endpoint + UpdateDashboardEmbeddingInput/DashboardEmbeddingResponse schemas to api-reference/api.yaml, registered it in docs.json, and added the two CLI subcommands to the embed row in reference/cli.mdx.
  • Dev-mode branch writes (feat(cube-cli): expose the dev-mode branch name and document dev-mode-only data-model writes #11351 / cubejs-enterprise #13309) — data-model file writes now only land on the personal dev-… branch forked by --dev-mode/dev-mode, not the branch name you passed in. The CLI reference's "Data model Git workflow" example still showed --branch my-branch, which is now rejected — updated the example and surrounding text to match the real flow.
  • cube with no subcommand now prints the installed CLI version before the help text (feat(cube-cli): show CLI version when run without a command #11344) — added a line to the Installation section.
  • ?devmode=true deep link into the Data Model IDE (cubejs-enterprise #13237) — undocumented opt-in URL param (combinable with ?branch=) to open the IDE straight into dev mode. Added a short paragraph to data-model-ide.mdx.
  • One-click unsubscribe for scheduled dashboard refresh emails (cubejs-enterprise #13246) — footer unsubscribe link plus RFC 8058 native mail-client "Unsubscribe" button. Added a sentence to scheduled-refreshes.mdx.

Other recent feat commits in both repos were reviewed and intentionally left out as not customer-facing per cubejs-enterprise/.claude/shared/customer-facing-criteria.md (internal telemetry, cloud-provisioner infra plumbing, invisible pre-aggregation-matching improvements, in-app snippet-formatting polish).

No feature found in this pass was large enough to warrant its own docs page, so no Linear ticket was filed.


Generated by Claude Code

…vmode deep link, and email unsubscribe

- Add PATCH /v1/embed/dashboard/{publicId} to the Control Plane API
  reference (enable/disable signed embedding for a dashboard, admin only),
  matching cube embed enable-dashboard/disable-dashboard in the CLI.
- Fix the CLI's Data model Git workflow example: writes now require the
  personal dev-mode branch forked by --dev-mode/dev-mode, not the branch
  name passed in.
- Document cube CLI printing its version when run with no subcommand.
- Document the ?devmode=true (+ ?branch=) deep link into the Data Model IDE.
- Document one-click unsubscribe (footer link + native mail-client button)
  on scheduled dashboard refresh emails.

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HNkDxYUamXdXN2AsrSYxKB
@claude

claude Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keydunov's task in 38s —— View job


Code Review

Verdict: LGTM — docs-only, well-scoped, no issues found.

Details
  • Read PR diff and changed files
  • Verify against docs-mintlify conventions (docs-mintlify/CLAUDE.md)
  • Check API spec additions (paths + schemas + registration)
  • Check inline prose changes

What was checked

File Notes
api-reference/api.yaml PATCH /v1/embed/dashboard/{publicId} added under the existing path item (correct OpenAPI shape), UpdateDashboardEmbeddingInput and DashboardEmbeddingResponse both defined and referenced. Admin-only + 404 semantics called out in x-mint.content. Consistent with the existing GET sibling.
docs.json New PATCH … entry sits directly under the GET in the Embed group — matches Mintlify's OpenAPI page convention already in use.
docs/data-modeling/data-model-ide.mdx Short paragraph, correctly notes the access-gate fallback (silently ignored). No new page — good, per "prefer surgical edits".
docs/explore-analyze/scheduled-refreshes.mdx One sentence, mentions RFC 8058 behavior in user-friendly terms ("one-click … Gmail"). Placed in the right subsection about email subscribers.
reference/cli.mdx Three edits: no-subcommand version print, enable-dashboard/disable-dashboard in the embed row, and the dev-mode branch-writes clarification with corrected example. The updated Git workflow example is now internally consistent (create-branch … --dev-mode → write to dev-my-branchmerge-to-default --branch my-branch).

Minor observations (non-blocking)

  • reference/cli.mdx:160 — the embed row is now the longest in the table; still readable, but if the row grows again consider splitting enable-dashboard/disable-dashboard into their own row or a sub-list. Not worth changing now.
  • api.yamlDashboardEmbeddingResponse mirrors the request body shape (just allowEmbed + publicId); worth confirming the real API response doesn't also return other fields (e.g. dashboard name/status) that clients might rely on. If it does, the schema should list them; if not, ignore.
  • data-model-ide.mdx:60 — copy is clear; you may also want to mention what happens if ?branch=<name> points at a branch the user doesn't have access to (same silent-ignore, or an error?). Optional — depends on actual behavior.

Nothing here blocks merge.

· [`claude/gallant-ramanujan-ae69ly`](https://github.com/cube-js/cube/tree/claude/gallant-ramanujan-ae69ly)

@mintlify

mintlify Bot commented Jul 26, 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 Jul 26, 2026, 12:16 AM

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

@mintlify

mintlify Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
cubed3 🟡 Building Jul 26, 2026, 12:15 AM

💡 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.

2 participants