Skip to content

Commit 367489b

Browse files
authored
Updating docs content and images (#401)
1 parent 68ba427 commit 367489b

File tree

6 files changed

+44
-57
lines changed

6 files changed

+44
-57
lines changed

docs/introduction/core-concepts.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This page explains how Plane is structured and how its features work together. U
88
## Understand Plane's structure
99
Plane is organized in a hierarchy that reflects how teams naturally work together:
1010

11-
At the top level, **Workspaces** contain everythingtypically one per organization, team, or client. Inside workspaces, you create **Projects** for specific products, initiatives, or goals. Within projects, you manage **Work items** (the individual tasks your team completes). You can organize these work items using **Cycles** (time-boxed periods) and **Views** (saved filters and layouts). Finally, **Pages** provide space to document context and decisions alongside your work.
11+
At the top level, **Workspaces** contain everything - typically one per organization. Inside workspaces, you create **Projects** for specific products, initiatives, or goals. Within projects, you manage **Work items** (the individual tasks your team completes). You can organize these work items using **Cycles** (time-boxed periods) and **Views** (saved filters and layouts). Finally, **Pages** provide space to document context and decisions alongside your work.
1212

1313
This structure gives you flexibility to work at whatever level makes sense. Sometimes you'll focus on a single work item. Other times, you'll view an entire project or cycle to understand the bigger picture.
1414

@@ -17,9 +17,9 @@ Understanding relationships between Plane's features helps you use them effectiv
1717

1818
### Workspaces
1919

20-
Think of a workspace as the central hub for everything you do on Plane. It’s the top-level space where all your projects and work items live. Workspaces are typically set up for a team, department, or company, and everyone within a workspace can collaborate on projects and access shared resources. You can also think of each workspace as a different organization or client you're working with, keeping things separate and organized.
20+
Think of a workspace as the central hub for everything you do on Plane. It’s the top-level space where all your projects and work items live. Workspaces are typically set up for a company or client, and everyone within a workspace can collaborate on projects and access shared resources. You can also think of each workspace as a different organization or client you're working with, keeping things separate and organized.
2121

22-
Inside a workspace, you have the freedom to create projects on your own or invite collaborators to join and share it as a teamit’s entirely up to you!
22+
Inside a workspace, you have the freedom to create projects on your own or invite collaborators to join and share it as a teamit’s entirely up to you!
2323

2424
Learn more about [Workspaces](/core-concepts/workspaces/overview).
2525

@@ -42,7 +42,7 @@ Learn more about [Work items](/core-concepts/issues/overview).
4242
Cycles help you organize work into time-bound periods, like sprints or phases. They’re perfect for planning work over specific intervals, letting your team know what’s coming up and what needs to be wrapped up. Cycles can contain multiple work items from different projects, making it easy to see your team’s workload at a glance and keep an eye on deadlines.
4343

4444
- You can move existing work items into a new or ongoing cycle or create new work items directly within a cycle.
45-
- Bulk operations are supported--you can add or update multiple work items to cycles at once.
45+
- Bulk operations are supported - you can add or update multiple work items to cycles at once.
4646
- You can't update work items after a cycle is completed, however, the pending work items can be transferred to a new or upcoming cycle.
4747

4848
Learn more about [Cycles](/core-concepts/cycles).
@@ -56,14 +56,12 @@ Learn more about [Views](/core-concepts/views).
5656

5757
### Pages
5858

59-
Pages are where you can jot down notes, add documentation, or outline plansthink of them as an AI-powered notepad. They’re perfect for quickly capturing ideas, taking notes during meetings, or starting your day with an organized list. Pages help you keep all your project-related information in one place, and because they’re easily accessible, you can refer to them whenever needed.
59+
Pages are where you can jot down notes, add documentation, or outline plansthink of them as an AI-powered notepad. They’re perfect for quickly capturing ideas, taking notes during meetings, or starting your day with an organized list. Pages help you keep all your project-related information in one place, and because they’re easily accessible, you can refer to them whenever needed.
6060

6161
Use Pages to record processes, share best practices, or simply keep team notes that everyone can refer to as needed.
6262

6363
Learn more about [Pages](/core-concepts/pages/overview).
6464

6565
---
6666

67-
With these core concepts under your belt, you’re ready to start exploring Plane and putting it to work for your team. Each feature is designed to help you and your team stay organized, collaborate effectively, and deliver your projects with ease.
68-
69-
Have questions? Ask the [Plane Community](https://discord.com/invite/29tPNhaV).
67+
With these core concepts under your belt, you’re ready to start exploring Plane and putting it to work for your team. Each feature is designed to help you and your team stay organized, collaborate effectively, and deliver your projects with ease.

docs/introduction/quickstart.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ This walkthrough will help you get up and running with Plane in no time. You’l
1010

1111
What you'll accomplish:
1212

13-
- Branded workspace ready for your team
13+
- Workspace ready for your team
1414
- Team members invited and working
1515
- First project with real work items
1616
- Sprint planning with cycles
1717

1818
## Before you begin
1919
- [Create a Plane account](/#get-plane)
2020

21-
## Set up your Workspace
21+
## Set up your workspace
2222
When you sign up for the first time on Plane, we'll prompt you to create a new Workspace. In this guide, you'll see how to customize the Workspace and invite your team members. Your workspace is the central hub where all your projects and team collaboration will happen, so let’s make it feel like home.
2323

2424
### Customize workspace details
2525

2626
![Workspace settings](https://media.docs.plane.so/quickstart/workspace-settings.webp#hero-tl)
2727

28-
1. Click on the workspace logo at the top left.
28+
1. Click on the workspace name at the top left.
2929
2. Select **Settings**.
3030
2. In the **General** tab under **Administration**:
3131
- Upload your company logo.
@@ -42,7 +42,7 @@ Get your team members into the workspace so they can start collaborating.
4242
- Type the email address in the provided box.
4343
- Select the role you want them to have.
4444
- Admin: Full workspace control and settings access.
45-
- Member (Default): Can create projects, issues, and collaborate fully.
45+
- Member (Default): Can create projects, work items, and collaborate fully.
4646
- Guest: Limited access to specific projects they're invited to.
4747
- Use the **+ Add more** link to invite multiple people at once.
4848
4. Click **Send invitation**.
@@ -59,10 +59,8 @@ Now that your workspace is ready, it’s time to create your first project. Proj
5959
2. Click the **Add Project** button.
6060
4. In the project creation form:
6161
1. Enter the name and write a brief description explaining what this project aims to accomplish.
62-
2. Select `Planning` in the **State** dropdown.
63-
3. By default, the project access is **Public** This means that all Workspace Admins and Members can see and join this project. Change this to **Private** if you want members to join only through invite.
64-
4. Select start and end dates if you want to and set a priority level.
65-
5. Assign a project Lead and add the Members you want to part of this project.
62+
2. By default, the project access is **Public**. This means that all Workspace Admins and Members can see and join this project. Change this to **Private** if you want members to join only through invite.
63+
3. Assign a project Lead and add the Members you want to be part of this project.
6664
5. Click **Create project** to finish the basic setup.
6765
6. You’ll see a modal with all the features enabled for this project. Leave the defaults as they are and click **Open project**.
6866

@@ -107,7 +105,7 @@ In this final step, you’ll learn how to organize your work into cycles (time-b
107105
- Click **Create cycle**.
108106
4. Click on your newly created cycle name to open it.
109107
5. Click **Add existing work item**
110-
6. Select the issues you created earlier.
108+
6. Select the work items you created earlier.
111109
7. Click **Add to cycle**.
112110
8. Return to the main Cycles page to view your active cycle with progress indicators.
113111

docs/introduction/tutorials/create-project.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Before creating your project, let's understand where all projects live in your w
2424
4. This is where all workspace projects are displayed.
2525

2626
### Understand project visibility
27-
- Public projects show for all workspace members with the **Join** option.
28-
- Projects you're part ofdisplay directly in your sidebar under the **Projects** section.
27+
- Public projects show for all workspace members (except Guests) with the **Join** option.
28+
- Projects you're part of display directly in your sidebar under the **Projects** section.
2929
- Private projects are only visible if you're specifically invited.
3030

3131
## Create your project
@@ -51,7 +51,7 @@ Start building a space for your team's work and collaboration.
5151
- **Description**: Add 1-2 sentences explaining the project's purpose.
5252
*Example*: "Complete redesign of company website focusing on improved user experience and modern design"
5353

54-
- **Project ID**: Plane automatically suggests a Project ID based on your project name (like "WEB" for "Website Redesign"). This ID will prefix all your issues (WEB-1, WEB-2, etc.).You can customize it, but keep it short (3-5 characters).
54+
- **Project ID**: Plane automatically suggests a Project ID based on your project name (like "WEB" for "Website Redesign"). This ID will prefix all your work items (WEB-1, WEB-2, etc.). You can customize it, but keep it short (3-5 characters).
5555

5656
- **Set project access**: Keep **Public** selected for now. This allows all workspace Admins and Members to see and join the project. You can change this to **Private** later if needed.
5757

@@ -154,7 +154,7 @@ Labels help categorize and organize your work.
154154

155155
1. **Access labels configuration**
156156
- In project settings, click **Labels** in the sidebar.
157-
- You'll see any existing labels (may be empty)
157+
- You'll see any existing labels (may be empty).
158158

159159
2. **Create essential labels**
160160
- Click **Add label** to create new labels.

docs/introduction/tutorials/create-workspace.mdx

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ If you've already signed up for Plane, you have your first workspace created dur
4949
- You can always invite more people later.
5050

5151
6. **Complete setup**
52-
- Click **Create workspace** to finish
53-
- You're automatically set as **Admin** with full permissions
52+
- Click **Create workspace** to finish.
53+
- You're automatically set as **Admin** with full permissions.
5454

5555
Your new workspace appears in the top-left and shows 1 Member (you).
5656

@@ -73,7 +73,6 @@ Understanding the sidebar helps you move efficiently around Plane.
7373

7474
### Personal section
7575
- **Home:** Your workspace home
76-
- **Inbox:** Notifications and mentions
7776
- **Your work:** All work items assigned to you across projects
7877

7978
### Workspace section
@@ -88,40 +87,32 @@ Understanding the sidebar helps you move efficiently around Plane.
8887
- Direct links to individual projects for both configuration and daily work
8988
- Shows all projects you're part of or have access to
9089

91-
### Additional options
92-
Click the **?** icon at the bottom of the sidebar to access:
93-
94-
- Documentation: Help guides and tutorials
95-
- Message support: Direct support chat
96-
- Keyboard shortcuts: Speed up your workflow
97-
- What's new: Latest Plane updates
98-
9990
## Manage multiple workspaces
10091

10192
Learn to work with multiple workspaces effectively.
10293

10394
### Switch between workspaces
10495

10596
1. **Access workspace switcher**
106-
- Click your workspace name (top-left)
107-
- All your workspaces are listed
108-
- Current workspace shows a checkmark ✓
109-
- Member count and your role appear for each
97+
- Click your workspace name (top-left).
98+
- All your workspaces are listed.
99+
- Current workspace shows a checkmark ✓.
100+
- Member count and your role appear for each.
110101

111102
2. **Navigate between workspaces**
112-
- Click any workspace to switch to it
113-
- Each workspace maintains its own projects and settings
103+
- Click any workspace to switch to it.
104+
- Each workspace maintains its own projects and settings.
114105

115106
### Join other workspaces
116107

117108
**When someone invites you:**
118-
- You'll receive an email notification
119-
- Accept from email or directly in Plane
109+
- You'll receive an email notification.
110+
- Accept from email or directly in Plane.
120111

121112
**To join from within Plane:**
122-
- Look for **Workspace invites** at the bottom of the switcher
123-
- Pending invitations appear here
124-
- Click to accept invitations from other teams
113+
- Look for **Workspace invites** at the bottom of the switcher.
114+
- Pending invitations appear here.
115+
- Click to accept invitations from other teams.
125116

126117
## Configure workspace settings
127118

docs/introduction/tutorials/invite-members.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ There are two ways to invite team members to your workspace:
2525

2626
**From workspace settings**
2727

28-
![Workspace members](https://media.docs.plane.so/tutorials/workspace-members.webp#hero)
28+
![Workspace members](https://media.docs.plane.so/tutorials/invite-team-members.webp#hero)
2929

3030
1. Click your workspace name, then **Settings**.
3131
2. In the left pane, click **Members** under **Administration**.
@@ -51,24 +51,24 @@ For each person you're inviting, select their role from the dropdown.
5151

5252
#### 👑 Admin
5353

54-
- Full workspace control and settings access
55-
- Can invite/remove members and manage billing
54+
- Full workspace control and settings access.
55+
- Can invite or remove members and manage billing.
5656
- Best for Workspace owners, team leads, IT administrators.
5757

5858
#### 👥 Member (Default)
5959

60-
- Can create projects, work items, and collaborate fully
61-
- Cannot change workspace settings or manage other members
62-
- Best for most team members, developers, designers, project contributors
60+
- Can create projects, work items, and collaborate fully.
61+
- Cannot change workspace settings or manage other members.
62+
- Best for most team members, developers, designers, project contributors.
6363

6464
#### 👁️ Guest
6565

66-
- Limited access to specific projects they're invited to
67-
- Cannot see other projects or workspace-level information
68-
- Best for External contractors, clients, temporary collaborators
66+
- Limited access to specific projects they're invited to.
67+
- Cannot see other projects or workspace-level information.
68+
- Best for external contractors, clients, temporary collaborators.
6969

7070
:::tip
71-
💡 Want a deeper breakdown? Check out the [full guide](https://docs.plane.so/core-concepts/workspaces/members) on roles and permissions.
71+
💡 Want a deeper breakdown? Check out the [full guide](/workspaces-and-users/permissions) on roles and permissions.
7272
:::
7373

7474
## Send invitations
@@ -82,9 +82,9 @@ Once you've added email addresses and selected roles:
8282

8383
**For invitees:**
8484

85-
- They receive an email with a join link
86-
- Can accept directly from email or from the workspace switcher
87-
- Join with the role you assigned them
85+
- They receive an email with a join link.
86+
- Can accept directly from email or from the workspace switcher.
87+
- Join with the role you assigned them.
8888

8989
## Manage your members
9090
Learn to adjust roles and monitor team membership.

docs/introduction/tutorials/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ By completing these tutorials, you'll have:
8282

8383
---
8484

85-
*These tutorials provide the foundation for effective team collaboration in Plane. Work through them at your own pace, and don't hesitate to revisit sections as your team grows and workflow needs evolve.*
85+
*These tutorials provide the foundation for effective team collaboration in Plane. Work through them at your own pace, and don't hesitate to revisit sections.*

0 commit comments

Comments
 (0)