Comments

Collaborate and give feedback on content directly within the documentation editor.

Plan: All

Overview

Commenting enables better collaboration by allowing team members to discuss and review content directly within the documentation editor. Add comments to any block, or highlight specific sections of text to provide context-specific feedback.
All users with access to the documentation editor can post comments and threaded replies, add reactions to comments, and mention team members.

Key features

  • Block comments: Comments can be added to any block, and they appear the right panel.
  • Inline comments: Team members can highlight text and add comments directly within the editor.
  • Threaded discussions: Keep discussions organized by replying to comments as a thread.
  • Mentions: Mention a user with @username to notify them directly. Mentioned users receive notifications, ensuring they see and respond to relevant comments.
  • Reactions: Add reactions to any comment.
  • Resolve and Reopen threads: Comment threads can be marked as resolved once addressed, and can be reopened if further discussion is needed.
  • Notifications: Receive notifications for new comments and replies. See Notifications for more details.

Add a comment to a block

Comments - block context menu
  1. Hover on the block you’d like to add a comment to, and click the ••• icon to open the block context menu.
  2. Select Comment from the menu.
  3. The comment popover will open. Type your comment and click the send icon to save it.
Comments - write a comment

Add an inline comment to text

Comments - add inline
  1. Highlight the text you would like to add a comment to.
  2. In the rich text bar, click the Comment icon.
  3. The comment popover will open. Type your comment and click the Send icon to save it.

View all comments on a page

Comments - panel

You can view all the comments added to one page by opening the Comments tab in the property panel on the right.

Show resolved comments

You can also view resolved comments on the page. In the dropdown menu at the top of the Comments tab, select Resolved to show all comments that have been marked as resolve. Select the Open comments option from this menu to see unresolved comments.

Search comments

Finally, you can search comments on the page using the Search bar at the top of the panel. You can search by user or by keyword.

View comments on a specific block

To view block comments, click the Comment icon to the right of the block to view all existing comments on a block.

Block comments also appear in the Comments tab.

View inline comments

To view an inline comment, simply click on the highlighted text to view the comment in a popover. Here you can reply to an inline comment, react to it, or resolve it.

Inline comments also appear in the Comments tab.

Comments - view inline

Reply or react to a comment

Comments - react & reply

To reply to a comment, click Reply below it and write your reply in the comment field.

To react to a comment, click the emoji icon and select your reaction emoji from the list.

Mention a user

To mention a user, click the @ icon or type @ and the user’s name. They will be notified that they were mentioned in a comment.

Comments - mention user

Resolve or reopen a thread

To resolve a comment:

  1. Hover on the relevant comment.
  2. Click the check icon in the comment box. It will be marked as resolved and removed from the open comments list.

To mark a comment as open again:

  1. Click Resolved comments to show all resolved comments.
  2. Hover on the relevant comment.
  3. Click the check icon at the top right of the comment aging. The comment will be marked as open again, and added back into the open comments list.