Update Plane AI page#450
Open
danciaclara wants to merge 5 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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, expanded Plane AI documentation page, replaces content in the old pi-chat doc, updates the VitePress sidebar link to ChangesPlane AI docs + routing
Estimated Code Review Effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
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. |
Comment on lines
+15
to
+20
| 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. | ||
|
|
Comment on lines
+40
to
+41
| reasoning block with a live to-do list of the AI's working steps (see Reasoning blocks | ||
| below). |
Comment on lines
+92
to
+101
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ------------------- |
![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
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/ai/plane-ai.md (1)
479-481: ⚡ Quick winRemove or populate the empty subsection heading.
### Available providers and modelsis currently an empty section and is immediately followed by another heading, which makes the page structure confusing.🤖 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/plane-ai.md` around lines 479 - 481, Remove or populate the empty subsection heading "### Available providers and models" in the docs/ai/plane-ai.md file: either delete that heading if no content is needed, or add the intended content (e.g., list of providers and supported models, configuration notes and examples) under the "### Available providers and models" heading so it is not immediately followed by "### Semantic search and the embedding model" and the document structure remains clear.
🤖 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/plane-ai.md`:
- Line 283: Update the broken MCP connector links by replacing the dead target
"/plane-ai/mcp-connectors" with the correct route "/ai/mcp-connectors" in the
document so both occurrences (the link at "See [MCP
connectors](/plane-ai/mcp-connectors)..." and the second instance referenced in
the comment) point to "/ai/mcp-connectors"; ensure the link text remains
unchanged and run the VitePress build to confirm the CI failure is resolved.
---
Nitpick comments:
In `@docs/ai/plane-ai.md`:
- Around line 479-481: Remove or populate the empty subsection heading "###
Available providers and models" in the docs/ai/plane-ai.md file: either delete
that heading if no content is needed, or add the intended content (e.g., list of
providers and supported models, configuration notes and examples) under the "###
Available providers and models" heading so it is not immediately followed by
"### Semantic search and the embedding model" and the document structure remains
clear.
🪄 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: ebb6f671-11c8-4b39-bbec-579900515622
📒 Files selected for processing (4)
docs/.vitepress/config.tsdocs/ai/pi-chat.mddocs/ai/plane-ai.mdvercel.json
💤 Files with no reviewable changes (1)
- docs/ai/pi-chat.md
✅ Files skipped from review due to trivial changes (1)
- docs/.vitepress/config.ts
|
|
||
| This restriction matches the purpose of each mode. Ask mode is read-only by design - adding action-capable connectors to it would break that guarantee. MCP connectors are fundamentally about doing things: posting to Slack, creating a GitHub issue, querying a customer record. Those are actions, not lookups, and they belong in the modes that are designed for action with the appropriate level of oversight. | ||
|
|
||
| See [MCP connectors](/plane-ai/mcp-connectors) for the full list of available connectors, how to connect them, and how authentication works. |
There was a problem hiding this comment.
Fix broken MCP connector links (CI is already failing).
The link target /plane-ai/mcp-connectors is dead in both places, and VitePress build fails because of it. Update both references to the actual route (likely /ai/mcp-connectors).
Proposed patch
-See [MCP connectors](/plane-ai/mcp-connectors) for the full list of available connectors, how to connect them, and how authentication works.
+See [MCP connectors](/ai/mcp-connectors) for the full list of available connectors, how to connect them, and how authentication works.
...
-- MCP connectors require per-user authentication setup before use. See [MCP connectors](/plane-ai/mcp-connectors).
+- MCP connectors require per-user authentication setup before use. See [MCP connectors](/ai/mcp-connectors).Also applies to: 510-510
🤖 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/plane-ai.md` at line 283, Update the broken MCP connector links by
replacing the dead target "/plane-ai/mcp-connectors" with the correct route
"/ai/mcp-connectors" in the document so both occurrences (the link at "See [MCP
connectors](/plane-ai/mcp-connectors)..." and the second instance referenced in
the comment) point to "/ai/mcp-connectors"; ensure the link text remains
unchanged and run the VitePress build to confirm the CI failure is resolved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit