Skip to content

Commit 9a6f1fd

Browse files
danciaclaradanciaclara
authored
Inline comments in Pages (#356)
* Inline comments in Pages * added images * review fixes
1 parent 276dcc8 commit 9a6f1fd

File tree

3 files changed

+150
-2
lines changed

3 files changed

+150
-2
lines changed

‎docs/core-concepts/pages/inline-comments.mdx‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
title: Inline comments
3+
hide_title: true
4+
description: Collaborate directly in Plane pages with inline comments. Highlight text, mention teammates, and resolve discussions across projects, wikis, and teamspaces.
5+
---
6+
7+
import Tags from "@site/src/components/Tags";
8+
9+
<div className="tag-wrapper">
10+
# Add inline comments in pages
11+
<Tags tags={[{ name: "Business", link: "https://plane.so/pricing", additionalClass: "business" }]} />
12+
</div>
13+
14+
Inline comments allow you to collaborate directly within your documentation by highlighting specific text and starting focused discussions. This feature is available across Project pages, Wiki pages, and Teamspace pages.
15+
16+
## Overview
17+
18+
When you need to discuss, clarify, or provide feedback on specific content in your pages, inline comments let you anchor conversations directly to the relevant text. Team members can respond to comments, mention colleagues, and mark discussions as resolved once they're addressed.
19+
20+
![Inline comments](https://media.docs.plane.so/pages/inline-comment.webp#center)
21+
22+
## Where you can use inline comments
23+
24+
Inline comments work across three different page types in Plane:
25+
26+
- **Project pages**
27+
Collaborate on project-specific documentation with your project team. Comments are visible to all project members.
28+
29+
- **Wiki pages**
30+
Discuss workspace-wide documentation that spans multiple projects. All workspace members can view and participate in these conversations.
31+
32+
- **Teamspace pages**
33+
Have focused discussions within your teamspace. Only teamspace members have access to these comments.
34+
35+
Each location functions independently, allowing you to keep conversations contextual to their scope.
36+
37+
## Add an inline comment
38+
39+
![Add inline comment](https://media.docs.plane.so/pages/add-inline-comment.webp#center)
40+
41+
To comment on specific text within any page:
42+
43+
1. Select the text you want to comment on by clicking and dragging across it.
44+
2. A comment icon will appear in the formatting toolbar above your selection.
45+
3. Click the icon to open the comment panel on the right.
46+
4. Type your comment in the text box.
47+
5. Optionally, attach images to provide visual context. See [Attach images](#attach-images-to-comments) below.
48+
6. Press the send button or use the keyboard shortcut to post.
49+
50+
Your comment will be anchored to the selected text, indicated by highlighting on the page.
51+
52+
## Attach images to comments
53+
You can add images to any comment or reply to provide screenshots, diagrams, or visual references:
54+
55+
- In the comment input field, click the attachment icon.
56+
- Select an image file from your device.
57+
- The image will be uploaded and attached to your comment.
58+
- You can attach multiple images to a single comment if needed.
59+
60+
## Mention team members
61+
62+
To bring specific people into the conversation:
63+
64+
1. Type `@` in the comment box.
65+
2. A dropdown menu will appear showing available team members.
66+
3. Start typing a name to filter the list.
67+
4. Click on the person you want to mention, or use arrow keys and press Enter.
68+
69+
<!-- Mentioned team members will receive a notification about the comment. -->
70+
71+
## Reply to comments
72+
73+
To continue a conversation thread:
74+
75+
1. Navigate to the Comments panel on the right side of the page.
76+
2. Find the comment you want to respond to.
77+
3. Click **Reply** below the comment.
78+
4. Type your response in the reply field.
79+
5. Send your reply.
80+
81+
Replies are threaded under the original comment, keeping related discussions organized.
82+
83+
## Manage comment status
84+
85+
### Resolve comments
86+
87+
When a discussion is complete or an issue has been addressed:
88+
89+
1. Locate the checkmark icon next to the comment (in the top-right area).
90+
2. Click the checkmark icon.
91+
3. Select **Mark as resolved**.
92+
93+
The comment will be hidden from the default view and moved to the resolved comments list.
94+
95+
### Unresolve comments
96+
97+
If a discussion needs to be reopened or the issue resurfaces:
98+
99+
1. Use the Filters button to show resolved comments.
100+
2. Locate the resolved comment you want to reopen.
101+
3. Click the checkmark icon next to the comment.
102+
4. Select **Mark as unresolved**.
103+
104+
The comment will return to the active comments list and become visible in the default view.
105+
106+
### Filter comments
107+
108+
Use the **Filters** button in the Comments panel to control which comments you see:
109+
110+
- **Show active**
111+
Displays only unresolved comments (default view).
112+
- **Show resolved**
113+
Displays only resolved comments.
114+
- **Show all**
115+
Displays all comments regardless of status.
116+
117+
This helps you focus on conversations that still need attention or review closed discussions when needed.
118+
119+
## Edit and delete comments
120+
121+
To modify or remove your own comments:
122+
123+
1. Click the three-dot menu (•••) next to your comment.
124+
2. Choose either:
125+
- **Edit**
126+
Modify the comment text and save your changes.
127+
- **Delete**
128+
Permanently remove the comment.
129+
130+
Note that only the comment author can edit or delete their own comments.
131+
132+
## Permissions and visibility
133+
134+
Comment permissions align with page access:
135+
136+
- **Project pages**
137+
Project admins and members can view and comment on all project pages. If you have access to view the project page, you can participate in its comment threads.
138+
139+
- **Wiki pages**
140+
Workspace admins and members can view and comment on wiki pages. For private pages that have been shared with you, you can also add and view comments based on your sharing permissions.
141+
142+
- **Teamspace pages**
143+
Only teamspace members can view and comment on teamspace pages. These comments remain private to the teamspace and are not visible to users outside the teamspace.
144+
145+
:::info
146+
Guest users can only comment on pages they create.
147+
:::

‎docs/core-concepts/pages/nested-pages.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: Nested Pages
2+
title: Nested pages
33
hide_title: true
44
description: Create structured documentation with Nested Pages. Build parent-child hierarchies, organize content logically, and improve navigation for your team's knowledge base.
55
---
66

77
import Tags from "@site/src/components/Tags";
88

99
<div className="tag-wrapper">
10-
# Structure content with Nested Pages
10+
# Structure content with nested pages
1111
<Tags tags={[{ name: "Business", link: "https://plane.so/pricing", additionalClass: "business" }]} />
1212
</div>
1313

‎sidebars.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ const sidebars: SidebarsConfig = {
134134
},
135135
"core-concepts/pages/wiki",
136136
"core-concepts/pages/nested-pages",
137+
"core-concepts/pages/inline-comments",
137138
],
138139
},
139140

0 commit comments

Comments
 (0)