mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2cb47e8389
* docs: improve SEO metadata for editor comments and suggestions pages * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
82 lines
3.0 KiB
Plaintext
82 lines
3.0 KiB
Plaintext
---
|
|
title: "Comment on pages in the editor"
|
|
sidebarTitle: "Comments"
|
|
description: "Leave inline comments on pages in the editor to give feedback, ask questions, mention teammates, and resolve threads before you publish changes."
|
|
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, 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 navigate to the comment in the editor.
|
|
|
|
The summary updates when you add, resolve, or delete a comment.
|
|
|
|
## Add a comment
|
|
|
|
1. Highlight the text you want to comment on.
|
|
2. Click the <Icon icon="message-square-text" /> **Comment** icon in the toolbar.
|
|
3. Type your comment and press <kbd>Enter</kbd> to submit.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/comment-light.png"
|
|
alt="The comment button in the floating toolbar above selected text in the web editor."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/comment-dark.png"
|
|
alt="The comment button in the floating toolbar above selected text in the web editor."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
## Reply to a comment
|
|
|
|
To open a comment thread, click the highlighted text or click the thread in the comment sidebar. Type your reply and press <kbd>Enter</kbd> to submit.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/reply-light.png"
|
|
alt="A comment thread opened in the web editor and two comment threads in the sidebar."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/reply-dark.png"
|
|
alt="A comment thread opened in the web editor and two comment threads in the sidebar."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
## Mention a teammate
|
|
|
|
Type `@` in a comment or reply to mention a teammate. 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.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/resolve-light.png"
|
|
alt="A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/resolve-dark.png"
|
|
alt="A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
## 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.
|