Skip to content
Open
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
41 changes: 41 additions & 0 deletions editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,44 @@
<Tip>
When you share a page, tell people which branch you're working on so they can confirm they view the correct version.
</Tip>

## Add comments

Use comments to provide feedback, ask questions, and collaborate on documentation content. Comments are attached to specific text selections and visible to all team members with access to the editor.

Check warning on line 86 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L86

In general, use active voice instead of passive voice ('are attached').

### Add a comment to text

1. Select the text you want to comment on.
2. Click the comment icon in the floating toolbar that appears.
3. Type your comment in the input field.
4. Click **Send comment** or press **Enter** to post your comment.

The commented text is highlighted in the editor, and a gutter icon appears next to the line showing the number of comment threads.

Check warning on line 95 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L95

In general, use active voice instead of passive voice ('is highlighted').

### View comments

View all comments for the current page in the comments sidebar on the right side of the editor.

- Click the comment badge in the top toolbar to open the comments sidebar.
- Click a gutter icon next to commented text to open the sidebar and focus that comment thread.
- Click a comment thread in the sidebar to highlight the associated text in the editor.

### Reply to comments

1. Type your reply in the **Reply...** input field at the bottom of the thread.

Check warning on line 107 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L107

In general, don't use an ellipsis.
2. Click **Send comment** or press **Enter** to post your reply.

### Resolve comments

Mark a comment thread as resolved when the discussion is complete or the feedback has been addressed.

Check warning on line 112 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L112

In general, use active voice instead of passive voice ('been addressed').

1. Click the checkmark icon on the first comment in the thread.

Resolved comments are removed from the sidebar and the text highlight is removed from the editor.

Check warning on line 116 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L116

In general, use active voice instead of passive voice ('are removed').

Check warning on line 116 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L116

In general, use active voice instead of passive voice ('is removed').

### Delete comments

1. Hover over the comment you want to delete.
2. Click the trash icon that appears.

Deleting the first comment in a thread deletes the entire thread. Deleting a reply removes only that comment.
1 change: 1 addition & 0 deletions editor/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
alt="Decorative image in dark mode"
/>

Create, edit, and publish documentation directly in your browser with the web editor. View and share previews of your changes; manage your site's navigation structure with drag-and-drop components; and publish updates using your team's preferred workflow.

Check warning on line 20 in editor/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/index.mdx#L20

Use semicolons judiciously.

Check warning on line 20 in editor/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/index.mdx#L20

Use semicolons judiciously.

## Key features

Expand All @@ -29,6 +29,7 @@
- **Git synchronization**: All changes sync automatically with your documentation repository.
- **Branch workflows**: Work on feature branches and create pull requests for review.
- **Team collaboration**: Multiple team members can work simultaneously with preview deployments.
- **[Comments and feedback](/editor/collaborate#add-comments)**: Add comments to text, reply to threads, and collaborate on documentation content.

## Get started

Expand Down