Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions docs/introduction/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Getting Started with Plane
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Add required front matter block

Line 1 starts with an H1, but this page is missing front matter. Please add at least title (required) and description (recommended).

Suggested patch
+---
+title: Getting Started with Plane
+description: Set up Plane in under 10 minutes with a step-by-step guide from signup to your first Cycle.
+---
+
 # Getting Started with Plane

As per coding guidelines, “Each Markdown file must have a front matter block with at minimum a title field, and should include description for SEO meta and og:description”.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Getting Started with Plane
---
title: Getting Started with Plane
description: Set up Plane in under 10 minutes with a step-by-step guide from signup to your first Cycle.
---
# Getting Started with Plane
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/getting-started.md` at line 1, Add a YAML front matter
block at the very top of the document (above the existing "Getting Started with
Plane" H1) containing at minimum a title field and a description field; for
example set title: "Getting Started with Plane" and add a short description
string for SEO/og:description, then ensure the front matter is closed with
triple dashes so the rest of the markdown (including the existing H1) remains
unchanged.


> New to Plane? This guide takes you from zero to a working project in under 10 minutes. No theory — just action.
>
> Already familiar with Plane? Head to [Core Concepts](./core-concepts.md) for feature deep-dives or [Tutorials](./tutorials/) for advanced workflows.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix docs link format and target path

Line 5 uses ./core-concepts.md, which violates the no-.md docs link rule and may point to the wrong location. Use the canonical docs path format.

Suggested patch
-> Already familiar with Plane? Head to [Core Concepts](./core-concepts.md) for feature deep-dives or [Tutorials](./tutorials/) for advanced workflows.
+> Already familiar with Plane? Head to [Core Concepts](/introduction/core-concepts) for feature deep-dives or [Tutorials](/introduction/tutorials/overview) for advanced workflows.

As per coding guidelines, “Use relative links between docs (e.g., Cycles) without .md extensions”.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/getting-started.md` at line 5, Update the docs link in the
sentence starting "Already familiar with Plane?" to use canonical docs paths
without .md extensions: replace "./core-concepts.md" with "/core-concepts/" and
ensure the tutorials link uses "/tutorials/" (or another top-level docs route)
instead of "./tutorials/"; keep the link text unchanged but use relative docs
paths that follow the no-.md rule.


## What is Plane? (30-second overview)

Plane is an open source project management tool — a free alternative to Jira or Linear. Here is all the terminology you need:

| Term | What it means |
|---|---|
| **Workspace** | Your organisation's home on Plane — everything lives here |
| **Project** | A specific area of work — e.g. "Website Redesign" |
| **Work Item** | A single task — e.g. "Fix login bug" |
| **Cycle** | A time-boxed sprint — a fixed period to complete work |
| **Module** | A group of related work items — like an epic |
| **View** | A saved filter — see exactly what you need |

## Before You Begin

You will need:
- A valid email address
- A browser (Chrome, Firefox, or Edge recommended)

## Step 1 — Create your Plane account

1. Go to [app.plane.so](https://app.plane.so)
2. Click **Sign Up** and enter your email address
3. Check your email for a verification link and click it
4. Set your name and password

> **Tip:** You can also sign up using your Google or GitHub account for faster access.

## Step 2 — Create your Workspace

1. After signing up you will be prompted to create a workspace
2. Enter your **Workspace Name** — use your company or team name
3. Choose your workspace URL
4. Select your team size
5. Click **Create Workspace**

> **Tip:** Choose your workspace name carefully — it is visible to all team members you invite.

## Step 3 — Invite your team

1. Click **Settings** in the left sidebar
2. Click **Members**
3. Click **Invite Members**
4. Enter your colleague's email address
5. Choose their role — Member for most people, Admin for those who need full control
6. Click **Send Invite**

## Step 4 — Create your first Project

1. Click **Projects** in the left sidebar
2. Click **Create Project**
3. Enter your Project Name — be specific (e.g. "Product Roadmap Q2")
4. Add a description
5. Choose network — Secret (invited members only) or Public (all workspace members)
6. Click **Create Project**

## Step 5 — Add your first Work Items

1. Inside your project click **Issues** in the left sidebar
2. Click **Create Issue**
3. Write a clear title — e.g. "Design homepage mockup" not just "Design work"
4. Set a Priority — Urgent, High, Medium, or Low
5. Assign it to a team member
6. Set a Due Date if needed
7. Click **Create Issue**

## Step 6 — Plan your first Cycle

1. Click **Cycles** in the left sidebar
2. Click **Create Cycle**
3. Give your Cycle a name — e.g. "Sprint 1 — April"
4. Set a Start Date and End Date — 1 or 2 weeks is a good starting point
5. Add work items from your backlog into the Cycle
6. Click **Create**

## What to Explore Next

| I want to... | Go to... |
|---|---|
| Understand all Plane features | Core Concepts |
| Learn advanced workflows | Tutorials |
| Set up Plane on my own server | Self-Host Plane |
| Connect Plane to GitHub or Slack | Integrations |
Comment on lines +84 to +89
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Make “What to Explore Next” destinations clickable links

Lines 86-89 are plain text labels, so the navigation table doesn’t function as navigation. Convert these cells to Markdown links.

Suggested patch
 | I want to... | Go to... |
 |---|---|
-| Understand all Plane features | Core Concepts |
-| Learn advanced workflows | Tutorials |
-| Set up Plane on my own server | Self-Host Plane |
-| Connect Plane to GitHub or Slack | Integrations |
+| Understand all Plane features | [Core Concepts](/introduction/core-concepts) |
+| Learn advanced workflows | [Tutorials](/introduction/tutorials/overview) |
+| Set up Plane on my own server | [Self-Host Plane](/self-hosting/overview) |
+| Connect Plane to GitHub or Slack | [Integrations](/integrations/overview) |

As per coding guidelines, “Use relative links between docs (e.g., Cycles) without .md extensions”.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| I want to... | Go to... |
|---|---|
| Understand all Plane features | Core Concepts |
| Learn advanced workflows | Tutorials |
| Set up Plane on my own server | Self-Host Plane |
| Connect Plane to GitHub or Slack | Integrations |
| I want to... | Go to... |
|---|---|
| Understand all Plane features | [Core Concepts](/introduction/core-concepts) |
| Learn advanced workflows | [Tutorials](/introduction/tutorials/overview) |
| Set up Plane on my own server | [Self-Host Plane](/self-hosting/overview) |
| Connect Plane to GitHub or Slack | [Integrations](/integrations/overview) |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/introduction/getting-started.md` around lines 84 - 89, The table rows
under "What to Explore Next" are plain text and must be converted to Markdown
links: replace the cell text for "Core Concepts", "Tutorials", "Self-Host
Plane", and "Integrations" with relative link syntax (e.g., [Core
Concepts](/core-concepts)) without .md extensions so the table cells become
clickable navigation; update the four cells in the diff rows that currently read
"Core Concepts", "Tutorials", "Self-Host Plane", and "Integrations" to their
corresponding relative link targets (e.g., /core-concepts, /tutorials,
/self-host, /integrations).


---

*This guide was contributed by Gori Goyal as part of the Plane Community Documentation Improvement Project (April 2026).*
2 changes: 2 additions & 0 deletions docs/introduction/tutorials/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Tutorials
description: Step-by-step guides to master Plane's essential features and build effective team workflows.
---

> 💡 **New to Plane?** If you're setting up Plane for the first time, start with the **[Quickstart guide](/introduction/quickstart)** for a step-by-step setup walkthrough. Come back here once you're set up to master advanced features.

# Tutorials

Master Plane's core features with hands-on, step-by-step tutorials designed to get you and your team productive quickly. These tutorials follow a logical progression from workspace setup to advanced collaboration, ensuring you build skills systematically.
Expand Down