Add inline comments
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.
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 Add comment button on the far right.
Type your comment and then hit the ➡️ button on the right side.
Unresolved comment are highlighted in yellow. Click on the highlighted word to open the comment box. The comment box offers the following options:
Continue thread - type your reply and hit the ➡️ button
Continue thread- Resolve comments (click the ✅ button in the upper right of the comment box)
Delete comments/thread (click the 🗑️ button in the upper right of the comment box)
Resolve and delete comment
❗
If you delete the comment thread, you will delete all of the replies as well.
Reopen a closed comment/thread by clicking the UNDO icon on the upper right of the comment box
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!
