Skip to content

Commit 5853054

Browse files
authored
New sidebar structure (#358)
* New sidebar structure * Structured the sidebar * code rabbit fixes * code rabbit fixes * Updated workspace and members pages * Updated billing and account sections * fixed broken links * updated more pages * fixed broken linke * Updated image CSS and fixed images * Fixed images * minor fix * code rabbit fixes * changed tool to software * minor fix * minor fix * added fallback css for images * removed fallback css for images
1 parent 9a6f1fd commit 5853054

File tree

85 files changed

+3944
-2828
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+3944
-2828
lines changed

docs/ai/pi-chat.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Pi (Plane Intelligence) is an AI assistant that helps you interact with your Pla
1616

1717
Think of Pi as a knowledgeable team member who has instant access to all your project data. You can ask it to find specific issues, analyze project progress, search through documentation, or help you understand complex relationships between work items.
1818

19-
![Pi chat sidebar](https://media.docs.plane.so/pi-chat/pi-chat-sidebar.webp#center)
19+
![Pi chat sidebar](https://media.docs.plane.so/pi-chat/pi-chat-sidebar.webp#hero)
2020

2121
## What Pi can do today
2222

@@ -64,15 +64,16 @@ The Action Executor Agent is in development and will enable these capabilities i
6464

6565
Pi is accessible from the left sidebar (Pi icon for a dedicated chat interface with recent history) or directly within a project’s Work Items and Cycles pages (Pi icon on the top right to start a new chat in a side panel without leaving your view).
6666

67-
![Pi chat project](https://media.docs.plane.so/pi-chat/pi-chat-project.webp#center)
67+
![Pi chat project](https://media.docs.plane.so/pi-chat/pi-chat-project.webp#hero)
6868

6969
### Start a conversation
7070

7171
1. Type your question in the chat input at the bottom of the Pi interface.
7272
2. Pi will process your query and provide a response.
7373
3. You can ask follow-up questions to dive deeper into the results.
7474
4. Use `@mentions` for direct entity reference, for eg., "@WEB-4651 what's the status of this issue?"
75-
![Pi chat mentions](https://media.docs.plane.so/pi-chat/pi-chat-mentions.webp#center)
75+
76+
![Pi chat mentions](https://media.docs.plane.so/pi-chat/pi-chat-mentions.webp#hero)
7677

7778
### Thread organization and management
7879

docs/automations/custom-automations.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Custom automations
2+
title: Automations
33
hide_title: true
44
description: Automate repetitive project tasks with trigger-based workflows. Set up rules to automatically update issue properties, assign team members, and manage priorities when specific conditions are met.
55
---
@@ -15,7 +15,7 @@ Automations let you streamline your project management workflow by automatically
1515

1616
Think of automations as your digital assistant that watches for specific events in your projects and responds according to rules you define. Whether it's updating issue statuses, assigning team members, adding labels, or posting comments, automations work behind the scenes to keep your projects moving smoothly.
1717

18-
![Create automations](https://media.docs.plane.so/automations/create-automation.webp#center)
18+
![Create automations](https://media.docs.plane.so/automations/create-automation.webp#hero)
1919

2020
## What automations do
2121
Automations follow a simple but powerful logic: When [trigger] happens, if [conditions] are met, then perform [actions]. This trigger-condition-action framework allows you to create sophisticated workflows that adapt to your team's specific needs.
@@ -35,7 +35,7 @@ You can create complex workflows by adding multiple conditions and multiple acti
3535

3636
## Set up automations
3737

38-
![Configure trigger and action](https://media.docs.plane.so/automations/configure-trigger-and-action.webp#center)
38+
![Configure trigger and action](https://media.docs.plane.so/automations/configure-trigger-and-action.webp#hero)
3939

4040
1. Navigate to your Project Settings.
4141

@@ -72,7 +72,7 @@ You can add multiple conditions to create more specific rules and multiple actio
7272

7373
## Manage automations
7474

75-
![Manage automations](https://media.docs.plane.so/automations/manage-automations.webp#center)
75+
![Manage automations](https://media.docs.plane.so/automations/manage-automations.webp#hero)
7676

7777
### Activity monitoring
7878
Track your automation's performance through the Activity panel, which shows:
Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
title: Work item comments
3+
description: Add comments, mention team members, and track activity on work items
4+
---
5+
6+
# Work item comments
7+
8+
Use comments to discuss work items, ask questions, provide updates, and collaborate with your team. Every work item includes a comment section and activity log.
9+
10+
## Add a comment
11+
12+
1. Open a work item.
13+
2. Scroll down to the Activity section.
14+
3. Click in the **Add comment** field.
15+
4. Type your comment using the rich text editor.
16+
5. Click **Comment** to post.
17+
18+
![Work item activity and comments](https://media.docs.plane.so/issues/issue-activity-comments.webp#hero)
19+
20+
Your comment appears immediately in the activity feed with a timestamp and your profile picture.
21+
22+
## Comment features
23+
24+
### Rich text formatting
25+
26+
The comment editor supports rich text formatting for clear communication:
27+
28+
**Available formatting:**
29+
- **Bold** - Emphasize important points
30+
- *Italic* - Add subtle emphasis
31+
- `Code` - Share code snippets or technical terms
32+
- Bullet lists - Organize information
33+
- Numbered lists - Create step-by-step instructions
34+
- Block quotes - Quote previous comments or external sources
35+
- Code blocks - Share longer code snippets with syntax
36+
- Links - Reference external resources
37+
38+
### Mention team members
39+
40+
Tag team members in comments to notify them and draw their attention to specific work items.
41+
42+
**To mention someone**
43+
1. Type `@` in the comment field.
44+
2. Start typing the person's name.
45+
3. Select their name from the dropdown list.
46+
4. Continue writing your comment.
47+
5. Post the comment.
48+
49+
**What happens**
50+
- The mentioned person receives an email notification (if they have notifications enabled)
51+
- The work item appears in their Inbox
52+
53+
## Manage comments
54+
55+
### Edit a comment
56+
57+
Update your comments to fix errors or add additional context.
58+
59+
1. Hover over your comment.
60+
2. Click the three dots (⋯) menu.
61+
3. Select **Edit**.
62+
4. Make your changes.
63+
5. Click **Save** (or press Escape to cancel).
64+
65+
You can only edit your own comments.
66+
67+
### Delete a comment
68+
69+
Remove comments that are no longer relevant or were posted in error.
70+
71+
1. Hover over your comment.
72+
2. Click the three dots (⋯) menu.
73+
3. Select **Delete**.
74+
4. Confirm the deletion.
75+
76+
You can only delete your own comments.
77+
78+
:::warning
79+
Deleted comments cannot be recovered.
80+
:::
81+
82+
### Copy comment link
83+
84+
Share a direct link to a specific comment for reference in other discussions or documents.
85+
86+
1. Hover over any comment.
87+
2. Click the three dots (⋯) menu.
88+
3. Select **Copy link**.
89+
90+
The link copies to your clipboard. When someone clicks the link, they'll be taken directly to that work item with the comment.
91+
92+
## Activity log
93+
94+
The Activity log shows a chronological history of everything that happens on a work item, including comments and system updates.
95+
96+
### Activity types tracked
97+
98+
**System activities:**
99+
- Work item creation
100+
- Status changes (To Do → In Progress → Done)
101+
- Assignee changes
102+
- Priority updates
103+
- Estimate changes
104+
- Due date modifications
105+
- Module or cycle assignments
106+
- Label additions or removals
107+
- Relation changes (blocking, blocked by, etc.)
108+
109+
**User activities:**
110+
- Comments posted
111+
- Time logged ([Worklogs](/core-concepts/issues/time-tracking))
112+
- Attachments uploaded
113+
- Description edits
114+
115+
### Filter activity
116+
117+
Show only specific types of activity to focus on what matters.
118+
119+
1. Click the **Filters** button in the Activity panel.
120+
2. Select activity types to display:
121+
- **All** - Show everything
122+
- **Comments** - Only comments
123+
- **Activity** - Only system updates (status changes, assignments, etc.)
124+
- **Worklogs** - Only time tracking entries
125+
3. The activity log updates immediately.
126+
127+
### Sort activity
128+
129+
Change the order in which activities appear.
130+
131+
**Sort options:**
132+
- **Newest first** (default) - Most recent activity at the top
133+
- **Oldest first** - Original activity at the top
134+
135+
Click the sort icon next to Filters to toggle between sort orders.
136+
137+
---
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: Project updates
3+
description: Share project status and track progress over time
4+
---
5+
6+
# Share project status with Project Updates
7+
8+
Project updates provide a way to share project status and create a timeline of project progress. Use updates to communicate where your project stands, highlight blockers, and keep stakeholders informed without requiring meetings or status check-ins.
9+
10+
**What are project updates**
11+
Updates are status posts that appear in your project's side panel. Each update includes a status indicator (On Track, At Risk, or Off Track) and a message describing the current state of the project. Updates appear in chronological order, creating a history of your project's progress over time.
12+
13+
**When to use project updates**
14+
- Regular status reporting (weekly sprints, monthly milestones)
15+
- Communicating blockers or risks to stakeholders
16+
- Keeping remote or distributed teams aligned
17+
- Creating a historical record of project decisions and progress
18+
- Providing visibility to team members who aren't in daily standups
19+
20+
## Turn on project updates
21+
22+
Project updates must be enabled in project settings.
23+
24+
![Turn on project updates](https://media.docs.plane.so/projects/turn-on-project-updates.webp#hero)
25+
26+
1. Navigate to your project.
27+
2. Click the **** icon next to your project name.
28+
3. Select **Settings**.
29+
4. Go to the **Project Updates** tab.
30+
5. Toggle the option on.
31+
32+
## Add a project update
33+
34+
1. Navigate to the **Overview** page under your project.
35+
2. Click the **rocket icon** (🚀) in the side panel to open the updates view.
36+
3. Click **Add an Update**.
37+
4. Select your project status from the dropdown.
38+
5. Write your update message in the text field.
39+
6. Click **Add update**.
40+
41+
![Add project updates](https://media.docs.plane.so/projects/add-project-updates.webp#hero)
42+
43+
Your update appears immediately in the updates timeline with a timestamp.
44+
45+
### Project status options
46+
47+
Each update requires a status indicator that signals the project's current state:
48+
49+
**🚀 On Track**
50+
The project is progressing as planned. Work is moving forward according to schedule, no significant blockers exist, and the team is meeting milestones as expected. Use this status for regular positive progress updates.
51+
52+
**⚠️ At Risk**
53+
The project has potential issues that need attention. There may be emerging blockers, resource concerns, or dependencies that could impact timelines if not addressed. Use this status to flag concerns early and request help before issues become critical.
54+
55+
**❗ Off Track**
56+
The project has significant blockers or delays. Critical issues are preventing progress, timelines are at risk, or major decisions are needed to get back on track. Use this status when immediate action or escalation is required.
57+
58+
## Collaborate on updates
59+
60+
Project updates support threaded discussions and reactions, allowing team members to engage with status updates directly.
61+
62+
**Start discussions**
63+
- Add comments in the thread below the update.
64+
- Use threads to discuss specific points, ask questions, or provide additional context.
65+
- Threaded discussions keep conversations organized and connected to the relevant update.
66+
67+
**Use emoji reactions**
68+
- React to updates with emojis for quick feedback.
69+
- Reactions provide lightweight acknowledgment without requiring a full comment.
70+
71+
**Mention team members** *(Coming soon)*
72+
- Tag specific team members in update comments to notify them directly.
73+
- Use mentions to request input, escalate issues, or delegate follow-up actions.
Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
2-
title: Home
2+
title: Personalize homepage
33
description: Customize your Home page with quick links, recent activity, and sticky notes to create a personalized dashboard for improved productivity.
44
---
55

6-
# Your personalized home for quick access
6+
# Personalize your homepage
77

88
The Home page serves as your personalized page, giving you quick access to essential tools, recent activity, and key features to enhance productivity. Here's everything you need to know about setting up and using the Home page efficiently.
99

10-
![Home](https://media.docs.plane.so/account/home-page.webp#center)
10+
![Home](https://media.docs.plane.so/account/home-page.webp#hero)
1111

1212
### Manage widgets
1313

1414
This section allows you to customize the visibility of different content areas on the Home page. You can choose to show or hide the **Quick links**, **Recents**, and **Your stickies** sections as per your preferences. This flexibility enables you to tailor the Home page to display only the information you find most relevant and useful.
1515

16-
### Quick links
16+
### Add quick links
1717

1818
Pin links to projects, pages, or external resources you frequently access. Save time by jumping directly to important destinations without navigating through menus.
1919

20-
### Recents
20+
### See recent visits
2121

2222
This section helps you quickly pick up where you left off or revisit items you've recently worked on. You can customize the view to show specific types of activity, such as only recent work items or projects.
2323

24-
### Your stickies
24+
### Manage stickies
2525

2626
Stickies allow you to create, organize, and personalize notes or reminders directly on your Home page:
2727

@@ -32,4 +32,5 @@ Stickies allow you to create, organize, and personalize notes or reminders direc
3232

3333
## See also
3434

35+
- [Your work](/your-work)
3536
- [Stickies](/core-concepts/stickies)

0 commit comments

Comments
 (0)