Plane Compose docs

[danciaclara]

Summary by CodeRabbit

Documentation

• Added comprehensive Plane Compose docs covering installation, getting started, workspace/schema/work item configuration, commands, monitoring, sync modes, cloning, and troubleshooting.
• Added a new "Plane Compose" entry to the dev-tools documentation sidebar for easier discovery.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
developer-docs	Ready	Preview, Comment	Feb 5, 2026 2:44pm

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a new “Plane Compose” documentation page and updates the docs sidebar to include a link to that page.

Changes

Cohort / File(s)	Summary
Navigation Update docs/.vitepress/config.mts	Inserted a Plane Compose nav item into the dev-tools sidebar linking to /dev-tools/plane-compose.
Plane Compose Documentation docs/dev-tools/plane-compose.md	Added a comprehensive documentation page describing the Plane Compose CLI: features, installation, getting started, project structure, schema/work-item definitions, sync modes (collaborative/declarative), commands, monitoring/rate limits, cloning, troubleshooting, and debugging examples.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hop through YAML, tidy and bright,
Compose your Plane with morning light.
Syncs and schemas in orderly play,
Docs to guide every step of the way. ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Plane Compose docs' directly and clearly describes the main change: adding documentation for Plane Compose. It accurately summarizes the primary purpose of the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch plane-compose

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/dev-tools/plane-compose.md`:
- Around line 45-58: Add a language identifier to the fenced tree block so
MarkdownLint MD040 is satisfied: update the triple-backtick fence that precedes
the project tree (the block showing "my-project/ … .plane/ state.json") to
include a language tag such as "text" (or "bash") so the fence reads ```text,
leaving the contents unchanged.

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@docs/dev-tools/plane-compose.md`:
- Around line 185-200: The fenced directory tree block in the Plane Compose docs
is missing a language identifier and triggers markdownlint MD040; update the
opening fence for the tree (the block that starts with ``` and contains the
my-project/ tree structure) to include the language identifier text (i.e.,
change the opening fence to ```text) so the tree block is consistently marked as
plain text like other tree blocks in the repo.
- Line 14: The markdown list item "**Auto-create projects**" is missing the
leading `-` so it won't render as a bullet; edit the line containing the literal
text "**Auto-create projects**" and prepend a `- ` to make it a proper list item
(e.g., "- **Auto-create projects**") so it appears correctly under the
surrounding bullet list.