Refactor Comment Dialog docs: consolidate overview, rename suggestion components - #308
Closed
rakesh-snippyly wants to merge 7 commits into
Closed
Refactor Comment Dialog docs: consolidate overview, rename suggestion components#308rakesh-snippyly wants to merge 7 commits into
rakesh-snippyly wants to merge 7 commits into
Conversation
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
…293) Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
* release-note pipeline start: v6.0.0-beta.11 * release-note pipeline checkpoint: v6.0.0-beta.11 01-agent-1 * release-note pipeline checkpoint: v6.0.0-beta.11 02-agent-2 * release-note pipeline checkpoint: v6.0.0-beta.11 03-agent-3 * release-note pipeline checkpoint: v6.0.0-beta.11 04-agent-4 * release-note pipeline checkpoint: v6.0.0-beta.11 05-agent-5 * release-note pipeline checkpoint: v6.0.0-beta.11 06-agent-6 * release-note pipeline checkpoint: v6.0.0-beta.11 07-agent-7 * release-note pipeline complete: v6.0.0-beta.11 * save --------- Co-authored-by: release-notes-bot <release-notes-bot@users.noreply.github.com> Co-authored-by: Rakesh <rakesh@snippyly.com>
….md (#304) Derived from a review of all 195 PRs and ~180 commits to main (rakesh-snippyly/ Rakesh and yoen-velt), the live docs, and the .claude/agents pipeline rules. - CLAUDE.md: master rule guide auto-loaded by Claude Code. Audience and golden rules, voice/tone (no em-dashes, no marketing fluff, concept-first, SDK names are law), terminology table, MDX component vocabulary with exact tab titles, code example rules (client vs Velt, Hook + API Method pattern, kebab-case non-self-closing HTML), page anatomy, changelog rules, linking, docs.json, git conventions, and a pre-publish checklist. - .claude/templates/: copy-paste skeletons verified against live files for release notes (changelog entry, upgrade guide, client notes), feature docs (overview/setup/customize-behavior/quickstart), UI customization (wireframes, primitives, variables pointer), and API reference (data models, api methods, react hooks). Templates live under .claude/ which the Mintlify build ignores. https://claude.ai/code/session_015qRRK7w4nbVX64YSGJDWZn Co-authored-by: Claude <noreply@anthropic.com>
…anges section, clarity edits (#307) * docs: update Suggestions for v6.0.0-beta.13 (autoCommit, summaryHtml, rename) * docs: tighten SEO descriptions on suggestions and comment dialog pages * docs: complete v6.0.0-beta.13 coverage, drop changelog Breaking Changes section, edit for clarity - Merge origin/main (beta.11/12 changelog entries, typo and link fixes) - Remove the Breaking Changes section from the 6.0.0-beta.13 changelog entry; changelog now carries only New Features and Bug Fixes per docs conventions - Fix stale detect-only framing after the autoCommit default change: Option 2 Tip, Option 3 intro and examples now require autoCommit: false; enableSuggestionMode/ disableSuggestionMode reference entries state the default and reset behavior - Document the summary-only commentHtml fallback and the event-builder summaryHtml surface; add null to TargetEditCommitHandler return union - Drop agent-only framing now that human-authored suggestions render the card: event table, accept/rejectSuggestion, commentType/CommentActionType, primitives and wireframes prose and headings (Agent Suggestion -> Suggestion) - Mark LegacySuggestionAction as deprecated/standalone-only across primitives, wireframes, wireframe-variables, and the structure page - Add the Suggestion card tree to the comment dialog structure page (React + HTML) - Fix v5 changelog anchor broken by the banner rename; de-duplicate the SuggestionBanner block in primitives.mdx - Plain-language edits for junior frontend engineers across the beta.13 entry, suggestions overview, and data-models rows; paste-complete code examples Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018h2dKpmZLzZdX7og3X7Wpr * docs: add concepts-style structure to Comment Dialog group, remove legacy suggestion components - Add a Comment Dialog Customization overview page modeled on the UI Customization concepts overview: the four ways to customize the dialog (wireframes, template variables, primitives, structure reference), when to use each, and a wireframes-vs-primitives comparison - Add the overview and the previously orphaned structure page to the Comment Dialog nav group; simple sidebar titles (Overview, Wireframes, Structure, Template Variables, Primitives) - Point each reference page's intro note at the new group overview - Remove the deprecated LegacySuggestionAction components from primitives, wireframes, wireframe-variables, and the structure page (unused) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018h2dKpmZLzZdX7og3X7Wpr --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
…nnotations (#299) * docs: document suggestion payload on V2 comment annotations * docs: add SEO descriptions to V2 comment annotations add/update pages * docs(rest-apis): align suggestion payload docs with house style and merge main - Merge main so the PR is up to date with the current base - Drop em-dashes from the new descriptions and field docs per CLAUDE.md - summary typed string | null to match CommentAnnotationSuggestionSchema - Drop agent-only phrasing in the update page's status note; suggestions can also be human-authored since v6.0.0-beta.13 - Cross-link the add page's suggestion field to the Suggestions guide Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018h2dKpmZLzZdX7og3X7Wpr --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructured Comment Dialog customization documentation to follow the consolidated, concept-first pattern established in the Suggestions docs. Added a new overview page that explains the four customization approaches (wireframes, template variables, primitives, structure reference) and when to use each. Renamed suggestion-related components to remove the "Agent" prefix, reflecting a broader suggestion capability beyond AI agents.
Key Changes
New overview page (
ui-customization/features/async/comments/comment-dialog/overview.mdx): Explains the four ways to customize the Comment Dialog and directs users to the right tool for their use case.Renamed suggestion components across primitives and wireframes:
VeltCommentDialogAgentSuggestionBanner*→VeltCommentDialogSuggestionBanner*(and all nested children)VeltCommentDialogAgentSuggestion*→VeltCommentDialogSuggestion*(wireframe only)VeltCommentDialogSuggestionAction*primitives (accept/reject now part of the main Suggestion component)Updated frontmatter across three pages:
sidebarTitlefield to primitives, wireframes, and variables pages for clearer sidebar navigationUpdated structure reference (
comment-dialog-structure.mdx): Reflected the renamed components and added a Note directing users to the overview.Updated cross-references: Modified links in
async-collaboration/suggestions/overview.mdx,docs.json, and API reference pages to use the new component names.Added documentation templates (
.claude/templates/): Created reusable skeletons for feature docs, UI customization pages, API reference, and release notes to enforce consistency across the docs site.Added CLAUDE.md: Comprehensive writing guide covering audience, voice, terminology, MDX components, and code example rules for all future documentation work.
Notable Details
https://claude.ai/code/session_018h2dKpmZLzZdX7og3X7Wpr