Skip to content
Merged
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
10 changes: 9 additions & 1 deletion editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

To add a comment, highlight text and click the <Icon icon="message-square-text" /> **Comment** icon in the toolbar or press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>M</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>M</kbd> (Windows).

To comment on a whole block, such as a paragraph, code block, image, table, or component, hover over the block, click <Icon icon="grip-vertical" /> **Block actions**, and select **Comment**. You can also place your cursor in the block without selecting any text and press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>M</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>M</kbd> (Windows). If someone deletes a block that has an unresolved comment, the thread moves beside the page title with a note that the commented block was removed.

Check warning on line 22 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L22

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

To comment on the whole page instead of specific text, use either of these options:

Expand All @@ -30,7 +30,7 @@

Type `@` to mention a teammate in a comment. They must be a member of your organization who has accepted their invitation. When you mention a teammate in a comment, they receive an email notification and an item in their [inbox](/dashboard/inbox). Manage which comment and suggestion emails you receive from the [Notifications](/dashboard/notifications) page of your dashboard.

Replies to threads you started or were mentioned in, and new comments and suggestions on pages you own, also appear in your inbox.

Check warning on line 33 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L33

In general, use active voice instead of passive voice ('were mentioned').

Comment threads appear in both visual and source mode. In source mode, you can read, reply to, and resolve existing threads, but starting a new comment requires visual mode.

Expand Down Expand Up @@ -83,7 +83,15 @@

To ask about specific text, highlight it and click <Icon icon="square-sparkles" /> **Ask Mintlify** in the toolbar. Mintlify opens a new comment on the highlighted text with `@mintlify` already added, so you only need to type your question.

The agent runs read-only when replying to comments. It can read pages and their open comments, view images, search and fetch web content, and search Mintlify's documentation, but it can't edit content, create suggestions, or publish. To make changes, open the [editor agent](/editor/agent) directly.
If you can edit content, you can also ask the agent to change the page from the thread. Admins and editors can edit content. Without [role-based access control](/dashboard/roles), every member can.

```text
@mintlify fix the typo in this sentence
```

The agent edits the page on the thread's branch only when your comment explicitly asks for a change. For questions, feedback, or suggestions, it answers and offers to make the change instead. When it edits the page, its reply says what it changed. The agent doesn't publish, so review its changes and [publish](/editor/publish) them yourself.

For [viewers](/dashboard/roles), the agent replies read-only. It can read pages and their open comments, view images, search and fetch web content, and search Mintlify's documentation, but it can't edit content.

Check warning on line 94 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L94

Use the Oxford comma in 'It can read pages and their open comments, view images, search and'.

Mentions work on private pages for members who already have access.

Expand Down
Loading