Skip to content

docs(explore-analyze): document chat Artifacts tab - #11862

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

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

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
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet

Description of Changes Made

The chat sidebar's Artifacts tab (in Analytics Chat, the Data Model Agent, and embedded chat) was renamed from a semantic-model-only "Changes" tab and now also collects explorations, workbooks, and dashboards saved during or explicitly linked to a conversation — with no public documentation. This adds a short "Artifacts" section to docs/explore-analyze/analytics-chat.mdx covering:

  • What lands in the tab (auto-saved objects, plus objects you ask the agent to link)
  • How to preview an artifact (dialog) or open its full page

Source: cubedevinc/cubejs-enterprise#14940 ("feat(chat): link saved artifacts to conversations").

🤖 Generated with Claude Code

https://claude.ai/code/session_01UNhy9SUJQU13Ur2ww2WM8h


Generated by Claude Code

The chat sidebar's Artifacts tab (renamed from a semantic-model-only
"Changes" tab) now also collects explorations, workbooks, and dashboards
saved during or linked to a conversation, with no public documentation.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UNhy9SUJQU13Ur2ww2WM8h
@mintlify

mintlify Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
cubed3 🟢 Ready View Preview Sep 13, 2026, 12:12 AM

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

@github-actions github-actions Bot added the docs Issues that require a documentation improvement label Sep 13, 2026
@claude

claude Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

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


Docs-only change, no blockers — 0 high, 2 medium, 3 low

Full review
  • Gather context (diff, PR body)
  • Read the changed file in full
  • Check docs conventions (docs-mintlify/CLAUDE.md) and related pages
  • Post inline comments and review summary

Summary

An 11-line addition to docs-mintlify/docs/explore-analyze/analytics-chat.mdx documenting the Artifacts tab. It follows the repo's "surgical edits over new content" guidance correctly — extends an existing page rather than creating one, no padding, no <Note>/<Info> scaffolding for a small feature. Placement between Queued messages and Sharing is sensible. No code, security, performance, or test surface. Frontmatter, heading level (H2), and link conventions are all fine.

Findings

# Severity Location Issue
1 Medium analytics-chat.mdx:57 "chat sidebar" conflicts with how the term is used elsewhere in the docs — inline
2 Medium analytics-chat.mdx:60-61 Colloquial example prompts ("keep … handy"), and two near-identical examples where one would do — inline
3 Low analytics-chat.mdx:63-64 "open its full page from there" — dangling referent — inline
4 Low cross-page Possible stale "Changes" references elsewhere — see below
5 Low analytics-chat.mdx:55 No screenshot or {/* TODO: screenshot */} placeholder

#4 — worth a quick verification. The PR body says the tab "was renamed from a semantic-model-only Changes tab." Two other pages still name a Changes tab/view:

  • docs-mintlify/docs/data-modeling/data-model-ide.mdx:107 — "review changes to files on the Changes tab"
  • docs-mintlify/docs/integrations/dbt.mdx:411 — "Review the generated cubes in the Changes view"

Both look like they refer to the IDE's file-diff tab, which is a different surface from the chat sidebar's tab, so they are probably untouched by this rename. But if the rename applied to the same tab these pages point at, they are now stale and should be updated in this PR. Only the enterprise repo can settle this.

#5 — optional. The docs convention is to wrap screenshots in <Frame> or leave {/* TODO: screenshot — ... */} when one is needed but not yet available. The Sharing section right below has a screenshot; a new UI tab is the kind of thing a reader benefits from seeing. Not a blocker — a placeholder comment would be enough.

Also considered

  • Scope: the PR body notes the tab also appears in the Data Model Agent and embedded chat, but only the Analytics Chat page is updated. Reasonable for a first pass — but if the Data Model Agent version behaves the same, a one-line cross-link from docs/data-modeling/ would help discoverability.
  • Semantic model changes: the section lists "explorations, workbooks, and dashboards" but not semantic-model changes, which the tab previously showed exclusively. On the Analytics Chat page that omission is probably correct; confirm the tab doesn't still surface them here.
  • Terminology: "explorations", "workbooks", "dashboards", "the agent" all match the taxonomy in docs-mintlify/CLAUDE.md. ✅
  • No prior review threads on this PR to resolve or dedupe against.
· [branch `claude/gallant-ramanujan-jkivas`](https://github.com/cube-js/cube/tree/claude/gallant-ramanujan-jkivas)

Comment on lines +57 to +61
The chat sidebar's **Artifacts** tab collects the explorations, workbooks, and
dashboards this conversation has touched. An object lands there automatically
when the agent saves it for you, and you can also ask the agent to link an
existing saved object so it's handy for reference — for example, "keep the Q3
revenue exploration handy" or "link the Executive Overview dashboard here."

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.

Two wording issues in this paragraph:

"chat sidebar" — on this page, Analytics Chat is the main surface, not a sidebar. In the rest of the docs "chat sidebar" means the agent panel inside a workbook (workbooks/index.mdx:52), so this reads as if the tab lives somewhere else. Suggest naming the panel the tab actually sits in on the Analytics Chat page.

The example prompts — "keep the Q3 revenue exploration handy" is unusually colloquial for the docs' "professional, direct, instructive" tone, and it doesn't state the action the user is asking for. "Link ... here" (the second example) is clearer and matches the tab's purpose; one good example is enough per the docs CLAUDE.md ("One good example beats three near-identical ones").

Suggested change
The chat sidebar's **Artifacts** tab collects the explorations, workbooks, and
dashboards this conversation has touched. An object lands there automatically
when the agent saves it for you, and you can also ask the agent to link an
existing saved object so it's handy for reference — for example, "keep the Q3
revenue exploration handy" or "link the Executive Overview dashboard here."
The **Artifacts** tab collects the explorations, workbooks, and dashboards this
conversation has touched. An object lands there automatically when the agent
saves it for you, and you can also ask the agent to link an existing saved
object — for example, "link the Executive Overview dashboard to this chat."

Fix this →

Comment on lines +63 to +64
Click an artifact to preview it in a dialog, or open its full page from
there.

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.

"open its full page from there" has a dangling referent — "there" is the preview dialog, but the sentence structure makes the two clauses read as parallel alternatives on the artifact itself. Make the second clause explicitly about the dialog:

Suggested change
Click an artifact to preview it in a dialog, or open its full page from
there.
Click an artifact to preview it in a dialog; from the dialog you can open the
object's full page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Issues that require a documentation improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants