Skip to content

Conversation

@danciaclara
Copy link
Collaborator

@danciaclara danciaclara commented Aug 8, 2025

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
    • Added a comprehensive user guide for Pi, the AI assistant, detailing its features, capabilities, usage instructions, and upcoming enhancements.
    • Introduced a new "AI" section in the documentation sidebar for easier access to Pi-related resources.

@vercel
Copy link

vercel bot commented Aug 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 8, 2025 2:20pm

@coderabbitai
Copy link

coderabbitai bot commented Aug 8, 2025

Walkthrough

A new documentation page for "Pi chat," Plane's AI assistant, was added. The sidebar configuration was updated to include a new "AI" category, featuring the Pi chat documentation. No changes were made to existing code or exported entities; only documentation and navigation structure were updated.

Changes

Cohort / File(s) Change Summary
Pi Chat Documentation
docs/ai/pi-chat.mdx
Added a comprehensive documentation page introducing and explaining the usage, features, and limitations of the Pi AI assistant.
Sidebar Update
sidebars.ts
Updated the sidebar configuration to include a new "AI" category with the "Pi chat" documentation entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

In the docs a new friend appears,
Pi the assistant, to calm your fears.
With chat and insight, it lends you a paw,
Helping you search, analyze, and stand in awe.
The sidebar now guides you to AI’s new den—
Hop in, dear user, and chat once again!
🐇✨

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f0f003b and c95a21d.

📒 Files selected for processing (1)
  • docs/ai/pi-chat.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/ai/pi-chat.mdx
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch pi-chat

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (6)
docs/ai/pi-chat.mdx (5)

23-23: Promote bold section labels to headings for ToC/anchors and scanability

Use h3s instead of bold text so Docusaurus generates anchors and these appear in the page ToC.

-**Search and discovery**
+### Search and discovery

-**Data analysis and insights**
+### Data analysis and insights

-**Contextual assistance**
+### Contextual assistance

Also applies to: 30-30, 38-38


79-79: Make “Conversational features” a proper heading

This is currently plain text and won’t be anchorable or included in the ToC.

-Conversational features
+### Conversational features

153-157: Clarify permission-aware sharing

State that shared responses respect workspace permissions to prevent overpromising and set correct expectations.

 - **Thumbs up/down**: Rate the helpfulness of Pi's response.
 - **Copy**: Copy the response text for use elsewhere.
 - **Share**: Share the conversation or specific responses with team members.
+- Permissions-aware: Shared responses respect workspace permissions; recipients only see content they can access.

23-37: Unify bullet punctuation

Bullets mix terminal punctuation. Pick a style and apply consistently. Example fixes below.

- - Cross-project discovery to find related content across multiple projects
+ - Cross-project discovery to find related content across multiple projects.

- - Generate reports on work item status and trends using complex filtering and aggregations
+ - Generate reports on work item status and trends using complex filtering and aggregations.

- - Identify bottlenecks and overdue tasks through intelligent database querying
+ - Identify bottlenecks and overdue tasks through intelligent database querying.

- - Convert natural language to optimized SQL queries for structured Plane data
+ - Convert natural language to optimized SQL queries for structured Plane data.

166-173: Add a dedicated “Security, data usage, and retention” section

Great start on permissions. Recommend a short, explicit section covering:

  • Where inference happens (in-house vs. model provider)
  • Data sent to providers and whether it’s used for training
  • Retention period for chat logs and logs access controls
  • Encryption in transit/at rest
  • Compliance posture (SOC 2/ISO) and subprocessors link

I can draft this section once you confirm policy details.

sidebars.ts (1)

126-131: LGTM; consider a generated index for “AI”

The category and doc ID look correct. Optionally add a generated index so “AI” has an index page and appears in search.

 {
   type: "category",
   collapsed: false,
   label: "AI",
+  link: {
+    type: "generated-index",
+    slug: "ai",
+    title: "AI",
+    description: "Guides for Plane’s AI features.",
+  },
   items: ["ai/pi-chat"],
 },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4da31d9 and f0f003b.

📒 Files selected for processing (2)
  • docs/ai/pi-chat.mdx (1 hunks)
  • sidebars.ts (1 hunks)
🔇 Additional comments (3)
docs/ai/pi-chat.mdx (3)

160-165: Verify “full Pi functionality” on mobile

Confirm that iOS/Android currently include Pi with feature parity. If not, qualify the claim (e.g., “core features”).


61-64: Confirm UI labels and entry points

Please verify the exact labels/locations (“Pi” icon in left sidebar; “Work Items” and “Cycles” pages, top-right) match the current UI so screenshots and text stay consistent.


95-97: Confirm “Show thinking” disclosure level

I wasn’t able to find evidence in the docs or codebase indicating whether Show thinking exposes raw chain-of-thought or just a high-level breakdown. Please verify the actual product behavior—specifically that it only displays sources, filters, and tools used (not internal prompts or reasoning)—and then apply the wording below.

Files to update:

  • docs/ai/pi-chat.mdx (lines 95–97, 101)

Proposed diff:

-Pi includes a **Show thinking** feature that reveals how it processes your queries.
-- Click **Show thinking** to see Pi's step-by-step reasoning process.
-- Watch as Pi understands your query, plans its approach, and executes database searches.
+Pi includes a **Show thinking** option that shows a high-level breakdown of how your query was handled (retrieved context, tools used, and approach) — not raw prompts or internal chain-of-thought.
+- Click **Show thinking** to see an outline of Pi's approach and the sources/filters it used.
+- See which sources were consulted, which filters were applied, and how results were aggregated.

-Pi provides structured responses that may include:
- Direct answers with relevant data from live Plane databases.
+Pi provides structured responses that may include:
+- Direct answers with relevant data from live Plane databases (based on your permissions)

Please confirm before merging.

@sriramveeraghanta sriramveeraghanta merged commit 05aee8c into master Aug 8, 2025
3 checks passed
@sriramveeraghanta sriramveeraghanta deleted the pi-chat branch August 8, 2025 14:20
@coderabbitai coderabbitai bot mentioned this pull request Sep 10, 2025
6 tasks
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.

3 participants