Update Plane AI page#450
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation for Plane AI Chat is updated with prerequisites for self-hosted Commercial Edition, a revised description of Plane AI as workspace-aware, expanded LLM provider and model selection details, detailed chat execution flow explanation, and comprehensive documentation of three chat modes with their permissions and behavior. ChangesPlane AI Chat Documentation
Estimated Code Review Effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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 |
There was a problem hiding this comment.
Pull request overview
Expands the Plane AI documentation page to describe the product’s AI surfaces, supported LLM providers/model selection, and how AI Chat works/modes.
Changes:
- Replaces the brief intro with a more detailed description of Plane AI capabilities and interaction surfaces.
- Adds sections for LLM providers/model selection and a deeper explanation of AI Chat internals and chat modes.
- Updates the self-hosted caution callout copy/title.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| > [!CAUTION] Plane self-hosted instances | ||
| > [!CAUTION] Self-hosted Commercial Edition | ||
| > If you're running a self-hosted instance of Plane, you'll need to first configure Plane AI services to get it working. Follow this [setup guide](https://developers.plane.so/self-hosting/govern/plane-ai) first to use Plane AI. |
| Plane AI spans four interaction surfaces: | ||
|
|
||
| - **AI Chat** - a persistent, conversational assistant that lives in a sidebar and knows your workspace context. | ||
| - **Writing Assistant** - AI actions embedded in the work item and page editor: rephrase, simplify, elaborate, summarize, adjust tone. | ||
| - **AI blocks** - generative content blocks you insert into pages, each powered by a separate AI generation that can be revised independently. | ||
|
|
| reasoning block with a live to-do list of the AI's working steps (see Reasoning blocks | ||
| below). |
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ------------------- |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/ai/pi-chat.md (1)
1-646:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winCI formatting check failed - run pnpm fix:format before committing.
The oxfmt formatting check is failing in CI. As per coding guidelines, formatting is enforced and the CI check must pass before merge.
Run the following command to fix:
pnpm fix:format🤖 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/ai/pi-chat.md` around lines 1 - 646, The CI oxfmt formatting check is failing for the updated documentation (see the "# Plane AI" and the new "## Turn off Plane AI for your workspace" section in pi-chat.md); run the repo formatter and reapply the formatting by executing the project formatter (pnpm fix:format), review the formatted changes in docs/ai/pi-chat.md, stage the updated file, and recommit/push so the CI formatting check passes.
🤖 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/ai/pi-chat.md`:
- Around line 15-20: The document states "Plane AI spans four interaction
surfaces" but only lists three bullets ("AI Chat", "Writing Assistant", "AI
blocks"); either update the heading to "three interaction surfaces" or add the
missing fourth surface (likely the "Slack agent") as a fourth bullet. Locate the
phrase "Plane AI spans four interaction surfaces" and the bullets for "AI Chat",
"Writing Assistant", and "AI blocks" and adjust the copy to be internally
consistent by changing the count or inserting a fourth item named "Slack agent"
(or another confirmed surface).
---
Outside diff comments:
In `@docs/ai/pi-chat.md`:
- Around line 1-646: The CI oxfmt formatting check is failing for the updated
documentation (see the "# Plane AI" and the new "## Turn off Plane AI for your
workspace" section in pi-chat.md); run the repo formatter and reapply the
formatting by executing the project formatter (pnpm fix:format), review the
formatted changes in docs/ai/pi-chat.md, stage the updated file, and
recommit/push so the CI formatting check passes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| Plane AI spans four interaction surfaces: | ||
|
|
||
| - **AI Chat** - a persistent, conversational assistant that lives in a sidebar and knows your workspace context. | ||
| - **Writing Assistant** - AI actions embedded in the work item and page editor: rephrase, simplify, elaborate, summarize, adjust tone. | ||
| - **AI blocks** - generative content blocks you insert into pages, each powered by a separate AI generation that can be revised independently. | ||
|
|
There was a problem hiding this comment.
Inconsistency: "four interaction surfaces" but only three listed.
Line 15 states "Plane AI spans four interaction surfaces" but only three are enumerated in the bullets below (AI Chat, Writing Assistant, AI blocks). Either add the missing fourth surface or correct the count to "three."
Based on the relevant context snippets, the Slack agent appears to be another Plane AI surface that could be the missing fourth item.
🤖 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/ai/pi-chat.md` around lines 15 - 20, The document states "Plane AI spans
four interaction surfaces" but only lists three bullets ("AI Chat", "Writing
Assistant", "AI blocks"); either update the heading to "three interaction
surfaces" or add the missing fourth surface (likely the "Slack agent") as a
fourth bullet. Locate the phrase "Plane AI spans four interaction surfaces" and
the bullets for "AI Chat", "Writing Assistant", and "AI blocks" and adjust the
copy to be internally consistent by changing the count or inserting a fourth
item named "Slack agent" (or another confirmed surface).
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit