Skip to content

Update Plane AI page#450

Merged
danciaclara merged 9 commits into
masterfrom
update-plane-ai
Jul 1, 2026
Merged

Update Plane AI page#450
danciaclara merged 9 commits into
masterfrom
update-plane-ai

Conversation

@danciaclara

@danciaclara danciaclara commented May 25, 2026

Copy link
Copy Markdown
Contributor

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Updated and expanded Plane AI documentation, including chat overview, three conversation modes (Ask/Build/Autopilot), workspace enablement, data/context scoping, model/provider selection, “thinking” behavior, and web search toggling.
    • Added coverage for action workflows, streaming edits in pages, and enhanced work item editor features (e.g., description generation, consent note, regeneration/feedback).
  • Chores
    • Updated the AI docs navigation to point to the new Plane AI page.
    • Added a redirect from the old /ai/pi-chat URL to /ai/plane-ai.

@vercel

vercel Bot commented May 25, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 1, 2026 1:12pm

Request Review

@coderabbitai

coderabbitai Bot commented May 25, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds a new Plane AI documentation page, rewrites the legacy pi-chat doc, updates the AI sidebar link to /ai/plane-ai, and adds a redirect from /ai/pi-chat to /ai/plane-ai.

Changes

Plane AI docs + routing

Layer / File(s) Summary
Routing updates
docs/.vitepress/config.ts, vercel.json
Update the AI sidebar target to /ai/plane-ai and add a redirect from /ai/pi-chat.
pi-chat doc replacement / deprecation notes
docs/ai/pi-chat.md
Replace the old intro with self-hosted setup guidance, a Plane AI overview, model selection details, chat flow, and Ask/Build/Autopilot mode docs.
Plane AI intro and core usage
docs/ai/plane-ai.md
Add the new Plane AI page, workspace enablement and entry points, plus the core Ask/Build/Autopilot usage and Ask-mode behavior.
Plane AI advanced features and constraints
docs/ai/plane-ai.md
Document Build/Autopilot workflows, page and work item integrations, model/provider details, semantic search, and access constraints.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: sriramveeraghanta, devanshuplane

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is related to the main change: it updates the Plane AI documentation page and its route.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-plane-ai

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

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread docs/ai/pi-chat.md Outdated

> [!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 thread docs/ai/pi-chat.md Outdated
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 thread docs/ai/pi-chat.md Outdated
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 thread docs/ai/pi-chat.md Outdated
Comment on lines +92 to +101









-------------------

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 win

CI 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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b17bdfdb-e392-4645-83cf-e1e2caa74d61

📥 Commits

Reviewing files that changed from the base of the PR and between fd8477f and 0b0ac83.

📒 Files selected for processing (1)
  • docs/ai/pi-chat.md

Comment thread docs/ai/pi-chat.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/ai/plane-ai.md (1)

479-481: ⚡ Quick win

Remove or populate the empty subsection heading.

### Available providers and models is 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

📥 Commits

Reviewing files that changed from the base of the PR and between 0b0ac83 and 22773a4.

📒 Files selected for processing (4)
  • docs/.vitepress/config.ts
  • docs/ai/pi-chat.md
  • docs/ai/plane-ai.md
  • vercel.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

Comment thread docs/ai/plane-ai.md Outdated
Comment thread docs/ai/plane-ai.md Outdated

![Plane AI chat sidebar](https://media.docs.plane.so/plane-ai/plane-ai.webp#hero)

Plane AI understands your workspace - work items, projects, cycles, modules, members, pages, comments, and more. When you ask something or give it a task, it draws from your actual data, not generic knowledge. It can also search the web and connect to external tools like GitHub and Slack through MCP connectors.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Slack is not yet available through MCP connectors. Replace it with Posthog or Granola

Comment thread docs/ai/plane-ai.md
- "Which issues are In Progress but have no assignee?"
- "What's blocking the API migration?"
- "Who is working on the most issues right now?"
- "Summarize the onboarding module"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

  • in What did the team ship last week?, team is ambiguous because Plane doesn't know your team. It can only guess.
  • This What's blocking the API migration? would work better if we use the specific entity reference - project, module or cycle

Comment thread docs/ai/plane-ai.md Outdated

### Suggestion tiles

When you open a new chat, a **Suggestions** section appears in the conversation area with a list of prompt ideas. These are fetched dynamically from Plane AI based on the current context - the active mode, the workspace, and which project or entity you're focused on. Click any suggestion to send it as your first message. All suggestions are disabled while Plane AI is generating a response.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

`dynamic' prompt suggestions are not yet implemented. We will soon, though!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@sunder-ch So, should i remove this section entirely, or just remove the word dynamically

Comment thread docs/ai/plane-ai.md
- States
- Issue views
- Teamspaces
- Initiatives

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Users and labels are not there in the mentions options, yet

Comment thread docs/ai/plane-ai.md Outdated
- Create relationships between work items: duplicate, related, blocking, blocked by, and more
- Add or remove subscribers
- Apply custom properties
- Upload and attach files

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pi can't do this, as of now

Comment thread docs/ai/plane-ai.md Outdated
- Add comments
- Log time worked (worklogs)
- Create relationships between work items: duplicate, related, blocking, blocked by, and more
- Add or remove subscribers

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pi can't do this, as of now

Comment thread docs/ai/plane-ai.md Outdated

**Pages**

- Create new pages or nested pages in any project

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No nested pages, as of now

Comment thread docs/ai/plane-ai.md Outdated

1. Describe what you want: "Create three sub-work items under PROJ-45 for the auth redesign - one for the login screen, one for token refresh logic, and one for session expiry handling."
2. Plane AI plans the actions and shows them as action cards. Each card shows the action type, key details, and what will be created or changed.
3. Review the plan. Edit individual cards if something looks wrong. Cancel any action you don't want.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cancelling individual cards/actions in a plan is not yet supported. But its one of the things in immediate pipeline

Comment thread docs/ai/plane-ai.md Outdated

Connectors are only available in Build and Autopilot modes.

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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

replace Slack with one of our supported connectors

Comment thread docs/ai/plane-ai.md Outdated

### The AI prompt input (page sidecar agent) <Badge type="tip" text="Business" />

The page editor includes an AI prompt input at the bottom of the editor. It shows a text field labeled **"Ask AI to edit this page…"** with the active model name. Type a free-form instruction describing what you want done to the page - for example:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This bottom floater to take input is removed. Now all instruction should be given from AI Assistant sidecar

@danciaclara danciaclara merged commit 05010cc into master Jul 1, 2026
5 checks passed
@danciaclara danciaclara deleted the update-plane-ai branch July 1, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants