# Comments

It takes a team to build great diagrams. Comments help clarify parts of your diagram, mark inaccuracies, or share ideas. Everyone in your organization can leave, view and resolve comments to add to the discussion.

{% hint style="info" %}
Comments are only visible to an organization's admins, editors, and viewers. Share-link viewers can't see them.
{% endhint %}

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FJvwdvO2U0o80eHmuHWvz%2Fcomments-1.gif?alt=media&#x26;token=cbf5fde0-c183-4487-8133-255922230f12" alt=""><figcaption><p>Browsing comments in IcePanel</p></figcaption></figure>

## Comment types

There are 3 comment types in IcePanel. Each comment type can be used to discuss a particular topic:&#x20;

* Question - to discuss parts that you're unsure about.
* Inaccuracy - to flag parts of the diagram that are incorrect.
* Idea - to share thoughts about changes or improvements.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2F9R1epjShO68ifWRRuzav%2Fcomment-types.png?alt=media&#x26;token=ca3f6081-bcec-43ce-9f63-64151a845d5e" alt="" width="266"><figcaption><p>Comment types in IcePanel</p></figcaption></figure>

### Question comment type

Questions should be used when you're unsure of part of the diagram, want to know how something works, or if something is unclear. Questions are added to the [recommendations tab](https://docs.icepanel.io/core-features/recommendation) to be resolved by your teammates.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FKcsXXbIoYiskNKa4IPFd%2FScreenshot%202024-02-22%20at%204.07.12%E2%80%AFPM.png?alt=media&#x26;token=a3d6fc06-15ad-4dd3-8491-c59a2705f19f" alt="" width="353"><figcaption><p>Question comment type</p></figcaption></figure>

### Inaccuracy comment type

Inaccuracy comments should be used when something in the diagram or documentation is untrue or has changed. Each inaccurate comment reduces the [Inaccuracy Score](https://docs.icepanel.io/integrations/accuracy-score) of the landscape, and resolving them will improve it.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FjhmtdDoDrYjk7haE7a6b%2FScreenshot%202024-02-23%20at%209.47.19%E2%80%AFAM.png?alt=media&#x26;token=02c7206e-4c9f-4e66-901b-c82666f19dad" alt="" width="375"><figcaption><p>Inaccuracy comment type</p></figcaption></figure>

### Idea comment type

Ideas are thoughts about future improvements to your architecture or diagram. For example, changes to a system or app to improve performance. Idea comments don't affect Inaccuracy Scores and can't be resolved (only deleted).

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FtWYgSCEsWIPePeiOJNrC%2FScreenshot%202024-02-22%20at%204.23.39%E2%80%AFPM.png?alt=media&#x26;token=a902add0-7d70-4583-b835-c3a8a9bd1368" alt="" width="345"><figcaption><p>Idea comment type</p></figcaption></figure>

## Adding comments

Comments can be added to any diagram and by all admins, editors, and viewers of your organization as long as they have access to a landscape. Share link readers **can't** add or view comments left by others.

To add a comment in a diagram:

1. Click the comment icon in the top right of the navigation bar, then the `New comment` button.
   1. Or, click on the `+` button on the left-hand toolbar.
2. Select the type of comment you want to add (Question, Inaccuracy, Idea).
3. Type in your comment.
4. Mention someone using '@'. They'll receive an email notification and see the comment under the Mentions tab in the comments dropdown
5. Click on the confirmation button. Each comment type button differs:
   * Question comment type: `Ask question`
   * Inaccurate comment type: `Mark as inaccurate`
   * Idea comment type: `Add idea`
6. Click and drag on the comment bubble to move it to the desired location.
7. Team members can reply to the comment in the comment box.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FnJOaFMsudrkLYTKbupvb%2Fadd-comment.gif?alt=media&#x26;token=81437ca8-bf17-43e8-840e-a0c6107e2bda" alt=""><figcaption><p>Adding a comment in a diagram</p></figcaption></figure>

## Viewing comments

If there are a lot of comments in a diagram or domain, you can quickly scan through them in the comment drop-down.&#x20;

To view all comments:

1. Click on the comment icon in the top right of the navigation bar
2. You'll see 3 tabs:
   * Your comments: Comments that you created
   * Mentions: Comments where you were mentioned
   * All comments
3. In each tab, you can sort through open and resolved comments

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2Fkj4bP5LzDyRk3T51cWCM%2Fview-comments.gif?alt=media&#x26;token=161d3afa-f8f8-46bb-9dba-35b1bc0b3069" alt=""><figcaption><p>Viewing comments in the comment dropdown</p></figcaption></figure>

## Editing comments

To edit a comment:

1. Click on the comment bubble or find it in the comment drop-down.
2. Click on the pencil ✏️ icon.
3. Edit the comment.
4. Click on the checkmark button.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FvigufafgJdheDe7WYn3u%2Fedit-comment.png?alt=media&#x26;token=39c643fa-852f-4296-91ab-4d265552981e" alt="" width="563"><figcaption><p>Editing a comment</p></figcaption></figure>

## Pinning comments

Pinning a comment makes the comment text visible in the diagram.

To pin a comment:

1. Click on the comment bubble or find it in the comment drop-down.
2. Click on the pin📍 icon in the top right of the comment box.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FR9Ls767ePloElIlWp7c5%2Fpin-comment.png?alt=media&#x26;token=9915f84b-7524-4d5a-8eff-c7253e3c88c3" alt="" width="563"><figcaption><p>Pinning a comment</p></figcaption></figure>

## Resolving comments

Questions and Inaccuracy comments can be resolved to remove them from the diagram and reduce their effect on the Recommendation and Inaccuracy Score.

To resolve a comment:

1. Go to the comment (must be a Question or Inaccuracy type).
2. Click the `Resolved ◻` check box.
3. The comment will be removed from the diagram.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2F3h4agONNdXVitpl1hj3p%2Fresolve-comment.png?alt=media&#x26;token=7f7d740c-8e70-4efe-9501-e901e699a917" alt="" width="563"><figcaption><p>Resolving a comment</p></figcaption></figure>

Resolved comments can still be accessed from the comments drop-down:

1. Click on the comment icon in the top right of the navigation bar.
2. Click on the `All comments` tab.
3. Click on the `Resolved comments` section to view all resolved comments.
4. If you want to restore the comment, click the comment and Resolved checkbox.

## Deleting comments

Only Idea comment types can be deleted.

To delete a comment:

1. Click on the comment bubble or find it in the comment drop-down.
2. Click on the trash 🗑️ icon to delete it.
3. Deleted comments can still be accessed in the drop-down under the resolved section.

<figure><img src="https://4065434276-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOHewp5hylgOsOa0VDOBo%2Fuploads%2FtCdS3GWCzULoOEbWCoMb%2Fimage.png?alt=media&#x26;token=a39a79ae-fa62-43b7-b700-1fa2f3269170" alt="" width="341"><figcaption><p>Deleting a comment</p></figcaption></figure>

## Notification

You’ll receive an email notification when:

1. **You’re mentioned in a comment**\
   Someone mentions you using `@your-name` in a new comment.
2. **Someone replies in a thread you’re involved in**\
   This includes threads where:
   * You started the conversation (you’re the original author), or
   * You were previously mentioned
3. **A comment is resolved**\
   If you started the thread or were mentioned in it, you’ll be notified when it’s resolved.

You **won’t** receive notifications when:

* You’re the one who wrote, replied to, or resolved the comment
