Skip to content
Closed
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
39 changes: 39 additions & 0 deletions editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,45 @@

Preview URLs are publicly accessible by default. Enable preview authentication in the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard to restrict access to authenticated organization members.

## Comments

Add comments to documentation text to discuss changes, ask questions, or provide feedback. Comments help teams collaborate on content without modifying the actual documentation.

### Add a comment

1. Select the text you want to comment on in the editor.
2. Click the comment icon (speech bubble) in the floating toolbar that appears.
3. Type your comment in the input field.
4. Click **Send comment** or press **Enter** to post the 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 75 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L75

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

### View comments

All comments for the current page appear in the comments sidebar on the right side of the editor. The sidebar shows:

- Comment threads grouped by date (Today, Yesterday, or the specific date)
- The quoted text each comment refers to
- All replies in each thread
- The author and timestamp for each comment

Click the comment badge in the top toolbar to open or close the comments sidebar. The badge shows the number of unresolved comments on the current page.

### Reply to comments

1. Open the comments sidebar or click a comment gutter icon.
2. Type your reply in the **Reply...** input field at the bottom of the thread.

Check warning on line 91 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L91

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

### Resolve or delete comments

- **Resolve**: Click the checkmark icon on a comment thread to mark it as resolved. Resolved threads are removed from the sidebar.

Check warning on line 96 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L96

In general, use active voice instead of passive voice ('are removed').
- **Delete**: Click the trash icon on a comment to delete it. Deleting the first comment in a thread deletes the entire thread.

<Note>
Comments are saved to your documentation repository and persist across branches. When you switch branches, you'll see comments specific to that branch.

Check warning on line 100 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L100

In general, use active voice instead of passive voice ('are saved').
</Note>

## Share editor links

Share a direct link to a specific page in the editor with your teammates. Use editor links to collaborate on updates and make changes to pages.
Expand Down
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**: Add comments to text, reply to threads, and resolve discussions directly in the editor.

## Get started

Expand Down