docs: add getting-started guide for new users#455
Conversation
Added a new getting-started.md guide to help new users set up Plane in under 10 minutes. Addresses navigation gap identified during documentation audit — users looking for practical setup guidance were navigating to Tutorials instead of Quickstart.
|
@Gori787 is attempting to deploy a commit to the Marketing at Plane Team on Vercel. A member of the Team first needs to authorize it. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a new "Getting Started with Plane" doc (overview, prerequisites, six setup steps, navigation table, contributor note) and a "New to Plane?" callout in the tutorials overview linking to the Quickstart. ChangesGetting Started Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with 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.
Inline comments:
In `@docs/introduction/getting-started.md`:
- 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.
- Around line 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).
- 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.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 97606f8e-20a3-4609-a1b9-aa55096ca2a8
📒 Files selected for processing (1)
docs/introduction/getting-started.md
| @@ -0,0 +1,93 @@ | |||
| # Getting Started with Plane | |||
There was a problem hiding this comment.
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 PlaneAs 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.
| # 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. |
There was a problem hiding this comment.
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.
| | 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 | |
There was a problem hiding this comment.
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.
| | 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).
|
@Gori787 Thanks for putting the effort to write this piece of documentation. But, we already have a Quickstart guide and detailed tutorials. Let us know if you see any gaps there so we can go ahead and update those. |
|
------------------------------
Hi, thank you for the quick response!
I completely understand — after conducting a full audit of both the
Quickstart guide and Tutorials section, I actually identified a specific
gap that I'd love to raise formally:
*Finding:* New users navigating to docs.plane.so for the first time
instinctively click "Tutorials" expecting a practical setup guide, but find
conceptual content there. The actual step-by-step setup guide sits in
Quickstart — which users assume is just a brief overview. This creates a
navigation mismatch based on user expectations of what "Quickstart" vs
"Tutorials" means.
*Suggestion:* A simple callout banner at the top of the Tutorials section
saying "Looking to set up Plane for the first time? Start with the
Quickstart Guide →" would solve this without any content rewrite.
I'm happy to submit a focused PR for just that change if the team thinks
it's worth exploring. I also have 4 other gaps documented from my audit —
happy to share those as GitHub issues if that's the preferred way to
propose improvements.
Thanks again for engaging with this!
…On Thu, 4 Jun 2026 at 14:23, Dancia ***@***.***> wrote:
*danciaclara* left a comment (makeplane/docs#455)
<#455 (comment)>
@Gori787 <https://github.com/Gori787> Thanks for putting the effort to
write this piece of documentation. But, we already have a Quickstart guide
<https://docs.plane.so/introduction/quickstart> and detailed tutorials
<https://docs.plane.so/introduction/tutorials/overview>.
Let us know if you see any gaps there so we can go ahead and update those.
—
Reply to this email directly, view it on GitHub
<#455?email_source=notifications&email_token=BJ5VS3U236IOSOUERH7RWBL46E2IPA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTINRSGA2TMNBQGUZ2M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#issuecomment-4620564053>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BJ5VS3VLYU4QVRJEQ5TRRZ346E2IPAVCNFSM6AAAAACZZZVOMOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DMMRQGU3DIMBVGM>
.
Triage notifications, keep track of coding agent tasks and review pull
requests on the go with GitHub Mobile for iOS
<https://github.com/notifications/mobile/ios/BJ5VS3SWAMIMLJKBX2DX4SD46E2IPA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTINRSGA2TMNBQGUZ2M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJKTGN5XXIZLSL5UW64Y>
and Android
<https://github.com/notifications/mobile/android/BJ5VS3X4INKCHQE4PLB3EKT46E2IPA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTINRSGA2TMNBQGUZ2M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLTGN5XXIZLSL5QW4ZDSN5UWI>.
Download it today!
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Yes that's sound like a good idea. You can change this PR with the callout at the top of the page leading them to the Quickstart guide. And sure, please raise GitHub issues for the other suggestions you have. Thanks |
Added a callout at the top of the Tutorials overview page directing new users to the Quickstart guide first. Addresses the navigation gap where new users land on Tutorials expecting a setup guide but find advanced workflow content instead.
|
Hi! I've updated the PR to replace the separate getting-started.md file with a callout banner at the top of the Tutorials overview page instead, as suggested. The banner directs new users to the Quickstart guide for first-time setup. |
2 participants
Description
Added a new
getting-started.mdguide to help new users set up Plane in under 10 minutes. This addresses a navigation gap identified during a full documentation audit — new users naturally navigate to Tutorials first expecting a practical setup guide, but find theory there. The actual step-by-step setup guide is in Quickstart which users assume is just a brief overview.Type of Change
What this PR adds
Why this matters
New users who want to set up Plane practically will instinctively click Tutorials first. This guide provides a clear action-oriented entry point and directs users to the right sections afterwards.
Summary by CodeRabbit