diff --git a/docs.json b/docs.json index e78206de1..a725721e5 100644 --- a/docs.json +++ b/docs.json @@ -69,6 +69,8 @@ "editor/configurations", "editor/live-preview", "editor/collaborate", + "editor/comments", + "editor/suggestions", "editor/publish", "editor/keyboard-shortcuts" ] diff --git a/editor/comments.mdx b/editor/comments.mdx new file mode 100644 index 000000000..c199401f5 --- /dev/null +++ b/editor/comments.mdx @@ -0,0 +1,80 @@ +--- +title: "Comments" +description: "Use comments to leave feedback, ask questions, and discuss changes with your team." +keywords: ["editor", "comments", "collaboration", "feedback", "mentions", "threads"] +--- + +Comments let you and your team leave feedback on specific text in a page without editing the content. Use comments to ask questions, flag issues, or discuss changes before you publish them. + +All [roles](/dashboard/roles)—-viewers, editors, and admins—-can leave and reply to comments. Only editors and admins can resolve comment threads. + +If your branch has an open pull request on GitHub, Mintlify adds a summary of unresolved comment threads to the pull request description. The summary lists the files with open comments, the first comment in each thread, and a link to open that file in the editor with the comment sidebar open. + +The summary updates automatically when you add, resolve, or delete a comment. + +## Add a comment + +1. Highlight the text you want to comment on. +2. Click **Comment** in the toolbar that appears. +3. Type your comment and press Enter to submit. + + + The comment button in the floating toolbar above selected text in the web editor. + The comment button in the floating toolbar above selected text in the web editor. + + +## Reply to a comment + +Open a comment thread by clicking the highlighted text or clicking the thread in the comment sidebar. Type your reply and press Enter to submit. + + + A comment thread opened in the web editor and two comment threads in the sidebar. + A comment thread opened in the web editor and two comment threads in the sidebar. + + +## Mention a teammate + +Type `@` in a comment or reply to mention a teammate. Select their name from the list that appears. People must be a member of your organization for you to mention them. + +Mentioned teammates receive an email notification. + +## Resolve a comment + +Editors and admins can resolve threads when a discussion is complete. + +Click the checkmark icon to resolve a thread. + + + A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted. + A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted. + + +## Delete a comment + +Click the trashcan icon beside a comment to delete it. Deleting the first comment in a thread deletes the entire thread. + +You can delete your own comments. Admins can delete any comment. diff --git a/editor/suggestions.mdx b/editor/suggestions.mdx new file mode 100644 index 000000000..705f37b33 --- /dev/null +++ b/editor/suggestions.mdx @@ -0,0 +1,51 @@ +--- +title: "Suggestions" +description: "Propose text changes as suggestions that teammates can accept or reject without editing the page directly." +keywords: ["suggestions", "suggesting", "collaboration", "review"] +--- + +Suggestions let you propose changes to text without modifying the existing content. Teammates can review, accept, or reject your suggestions. + +If your branch has an open pull request on GitHub, Mintlify adds a summary of open suggestions to the pull request description. The summary lists the files with suggestions, a preview of each suggested change, and a link to open that file in the editor. + +The summary updates automatically when you add, accept, or reject a suggestion. + +## Enable suggesting mode + +1. Highlight any text on the page. +2. Click the **Switch to Suggesting** button, the pen icon, in the toolbar that appears. + +While suggesting mode is active, the **Suggesting** indicator appears in the editor toolbar. + +To exit suggesting mode, click the **Suggesting** indicator. + + + The switch to suggesting button in the floating toolbar above selected text in the web editor. The Suggesting indicator is visible in the top toolbar. + The switch to suggesting button in the floating toolbar above selected text in the web editor. The Suggesting indicator is visible in the top toolbar. + + +## Make a suggestion + +With suggesting mode enabled, edit any text. Any deletions or insertions appear with distinct highlighting so that reviewers can see what changes you propose. + +## Accept a suggestion + +1. Click highlighted suggestion text. +2. Click the accept button, the checkmark icon, to apply the suggested change. + +Accepting a suggestion saves the updated text and resolves the suggestion thread. + +## Reject a suggestion + +1. Click highlighted suggestion text. +2. Click the reject button, the trashcan icon, to discard the proposed change. + +Rejecting a suggestion preserves the original text and resolves the suggestion thread. diff --git a/images/editor/comment-dark.png b/images/editor/comment-dark.png new file mode 100644 index 000000000..f25329a80 Binary files /dev/null and b/images/editor/comment-dark.png differ diff --git a/images/editor/comment-light.png b/images/editor/comment-light.png new file mode 100644 index 000000000..39c7e5cdd Binary files /dev/null and b/images/editor/comment-light.png differ diff --git a/images/editor/reply-dark.png b/images/editor/reply-dark.png new file mode 100644 index 000000000..b07095265 Binary files /dev/null and b/images/editor/reply-dark.png differ diff --git a/images/editor/reply-light.png b/images/editor/reply-light.png new file mode 100644 index 000000000..8d8cc16cc Binary files /dev/null and b/images/editor/reply-light.png differ diff --git a/images/editor/resolve-dark.png b/images/editor/resolve-dark.png new file mode 100644 index 000000000..764aa05f9 Binary files /dev/null and b/images/editor/resolve-dark.png differ diff --git a/images/editor/resolve-light.png b/images/editor/resolve-light.png new file mode 100644 index 000000000..02a95b998 Binary files /dev/null and b/images/editor/resolve-light.png differ diff --git a/images/editor/suggesting-dark.png b/images/editor/suggesting-dark.png new file mode 100644 index 000000000..a1f10a452 Binary files /dev/null and b/images/editor/suggesting-dark.png differ diff --git a/images/editor/suggesting-light.png b/images/editor/suggesting-light.png new file mode 100644 index 000000000..5383d8512 Binary files /dev/null and b/images/editor/suggesting-light.png differ