Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
"editor/configurations",
"editor/live-preview",
"editor/collaborate",
"editor/comments",
"editor/suggestions",
"editor/publish",
"editor/keyboard-shortcuts"
]
Expand Down
80 changes: 80 additions & 0 deletions editor/comments.mdx
Original file line number Diff line number Diff line change
@@ -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 <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

Open a comment thread by clicking the highlighted text or clicking 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. 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.

<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.
51 changes: 51 additions & 0 deletions editor/suggestions.mdx
Original file line number Diff line number Diff line change
@@ -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.

<Frame>
<img
src="/images/editor/suggesting-light.png"
alt="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."
className="block dark:hidden"
/>
<img
src="/images/editor/suggesting-dark.png"
alt="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."
className="hidden dark:block"
/>
</Frame>

## 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.
Binary file added images/editor/comment-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/comment-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/reply-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/reply-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/resolve-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/resolve-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/suggesting-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/suggesting-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.