Skip to content

docs: Describe dashboard version summaries and the written review message - #12634

Open
igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-6612-docs-dashboard-version-summaries
Open

igorlukanin wants to merge 1 commit into
masterfrom
igor/cub-6612-docs-dashboard-version-summaries

Conversation

@igorlukanin

Copy link
Copy Markdown
Member

Summary

  • Revision history: each version shows one line on what it changed, and AI may reword it after publishing.
  • Viewer version chip: shows the version's one-line summary.
  • Reviews: the request dialog writes the message on open, with Cancel; each review revision shows its own line.

Lands together with the product change; merge once it ships.

Test plan

  • Mintlify preview renders both pages

@igorlukanin
igorlukanin requested a review from keydunov as a code owner November 6, 2026 02:40
@mintlify

mintlify Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
cubed3 🟢 Ready View Preview Nov 6, 2026, 2:40 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 Nov 6, 2026
@claude

claude Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 52s —— View job


Looks good to merge once the product change ships: 0 high, 0 medium, 2 low.

Review details
  • Read diff and changed files
  • Form findings
  • Check prior review threads
  • Post inline comments and summary

Findings

Severity Location Issue
Low docs-mintlify/docs/explore-analyze/dashboards/reviews.mdx:51 "Check the message" sounds like the checkbox wording in step 3. Readers could also take "click Cancel" for the dialog's own Cancel, which closes it.
Low docs-mintlify/docs/explore-analyze/dashboards/index.mdx:59 "Before this line existed" only makes sense right after launch. The edit also leaves Select a alone on a short line, and line 69 runs past the ~80-column wrap.

Notes

  • Docs requirement: this PR is the docs. Both new behaviours are described on the pages users would look for them: the one-line version and revision summaries, and the AI-written review message.
  • The changes stay within the existing sections and match docs-mintlify/CLAUDE.md conventions. No new pages, so docs.json doesn't need an entry.
  • The Mintlify preview built successfully (🟢 Ready). I didn't check the rendered pages by eye.
  • Review threads: no prior threads. The listing returned 0 of my threads, so nothing was resolved or re-affirmed.

Comment on lines +51 to +53
4. Check the message under **Message (optional)**. When the dialog opens, AI
writes it from what the draft changes; while it writes, click **Cancel** to
stop it. Edit or clear the message as you like — typing also stops it.

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.

Low. Two words here can be read the wrong way:

  • "Check the message": three lines up, "check the default reviewers" means ticking checkboxes. A reader may look for a checkbox next to the message. "Review the message" avoids that.
  • "click Cancel to stop it": a request dialog usually has its own Cancel that closes it. If the stop control is a separate button near the message field, say where it is (e.g. "click Cancel next to the message"). Otherwise readers will worry that clicking it throws away the whole request.
Suggested change
4. Check the message under **Message (optional)**. When the dialog opens, AI
writes it from what the draft changes; while it writes, click **Cancel** to
stop it. Edit or clear the message as you like — typing also stops it.
4. Review the message under **Message (optional)**. When the dialog opens, AI
writes it from what the draft changes; while it writes, click **Cancel** next
to the message to stop it. Edit or clear the message as you like — typing also stops it.

(Change "next to the message" to wherever the button actually sits.)

Comment on lines +58 to +59
reword it a few seconds later to name the change inside a widget. Versions
published before this line existed have none. Select a

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.

Low. "Versions published before this line existed have none" depends on when the feature launched, and it won't make sense once readers no longer know there was a time without summaries. The edit also leaves Select a alone on a short line.

Suggested change
reword it a few seconds later to name the change inside a widget. Versions
published before this line existed have none. Select a
reword it a few seconds later to name the change inside a widget. Older versions
may have no summary. Select a

Reflow the rest of the paragraph to match. Line 69 (its one-line summary, and what changed…) is also past the paragraph's ~80-column wrap.

This branch was successfully deployed

1 active deployment
staging - docs-mintlify — edb976bc Deployed Nov 6, 2026 by mintlify[bot]
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.

1 participant