DOCUMENTS

Add inline comments

2min

Comments are an excellent way to engage your colleagues in a discussion about a certain topic that you may need clarification for. They enable you to provide feedback on the content, share valuable insights, ask questions, and foster collaboration and teamwork.

Additionally, you can use comments to create notes for yourself as you're going through your documentation.

How does it work?

1

In the editor, highlight any piece of text (a word, a whole phrase, or an entire paragraph). The menu bar will pop up - click the Comment button on the far right.

Comment button
Comment button

2

On the right side of the page, a conversation will open where you can leave a comment or engage your colleagues in a discussion

Document image

3

Unresolved comments are marked in light yellow. Click the highlighted text to open the comment box in the right sidebar. The comment box provides the following options:

  1. Continue thread - type your answer and hit the "Reply" button
  2. Resolve comments (click the ✔️ button in the upper right of the comment box)
  3. Delete comments/thread (click the 🗑️ button in the upper right of the comment box)

❗If you delete the comment thread, you will delete all the conversation as well

4

Reopen a closed comment/thread by clicking the UNDO icon on the upper right of the comment box

Document image


A closed/resolved comment thread is highlighted in grey. When a comment thread is resolved, it will still keep history in that thread, until deleted. The text will stay highlighted in grey until the thread is deleted.

💡You can tag a specific team member or mention @document_name as well in the comment thread.

Check out @ Mentions and dynamic links for more info!



🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.