Merge branch 'main' into readme

jmacdotorg · web-flow · commit 24f37b1c6091 · 2025-05-13T17:28:18.000-04:00
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -66,7 +66,7 @@ We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as Ge
 
 We've expanded our static analysis capabilities with two new tools:
 
-- **oxlint**: A high-performance JavaScript/TypeScript linter written in Rust.
+- **Oxlint**: A high-performance JavaScript/TypeScript linter written in Rust.
 - **Prisma Lint**: A dedicated linter for Prisma schema files to help enforce consistent conventions and best practices.
 
 Both tools can be configured through their respective config files or through CodeRabbit's settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
@@ -124,8 +124,8 @@ We're thrilled to introduce agentic planning on GitHub for CodeRabbit chat as an
 We are continually expanding our support for static analysis tools. We've recently added support for:
 
 - SQLFluff
-- Added oxlint for faster linting
-  - oxlint is a blazingly fast JavaScript/TypeScript linter written in Rust
+- Added Oxlint for faster linting
+  - Oxlint is a blazingly fast JavaScript/TypeScript linter written in Rust
   - Replaces ESLint for basic linting while maintaining ESLint for more complex rules
   - Up to 50-100x faster than traditional ESLint
 
diff --git a/docs/faq.md b/docs/faq.md
@@ -31,10 +31,10 @@ CodeRabbit works with all programming languages, with varying proficiency based
 
 <Tabs>
   <TabItem value="storage" label="Code Storage" default>
-    - No persistent code storage
-    - Temporary cloning during review only
     - Complete data isolation
-    - Immediate disposal post-review
+    - Caching of encrypted code and dependency archives for faster reviews
+    - Code indexing in which we store vector representations of code for efficient code base context
+    - Both caching and code indexing can be disabled which means we store nothing post-review
   </TabItem>
   <TabItem value="training" label="Training Data">
     - Uses only public datasets
@@ -92,7 +92,7 @@ Email field and click Update to save your changes.
 ### Usage and Configuration
 
 - **Language Settings**: Configure review language in repository settings
-- **Review Rules**: Customize via [Review Instructions](/guides/review-instructions)
+- **Review Rules**: Customize via [review instructions](/guides/review-instructions)
 - **Branch Selection**: Default branch reviews enabled by default (configurable)
 
 ### Access & Permissions
@@ -108,7 +108,7 @@ Interact with CodeRabbit by:
 1. Replying directly to CodeRabbit comments
 2. Tagging `@coderabbitai` in PR discussions
 3. Adding review comments for specific lines
-4. Customize via [Review Instructions](/guides/review-instructions)
+4. Customize via [review instructions](/guides/review-instructions)
 
 :::tip Collaboration Mode
 When team members are active in PRs, use `@coderabbitai` to engage the bot.
diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md
@@ -1,6 +1,5 @@
 ---
-title: Docstrings generation with CodeRabbit
-sidebar_label: Docstrings
+title: Generate docstrings
 description: Automated docstrings pull requests with CodeRabbit
 ---
 
diff --git a/docs/getting-started/adding-organizations.md b/docs/getting-started/adding-organizations.md
@@ -1,8 +1,6 @@
 ---
-title: Adding Organizations
+title: Add organizations
 description: Learn how to add new organizations to CodeRabbit
-sidebar_label: Adding Organizations
-sidebar_position: 5
 ---
 
 To add new organizations to CodeRabbit, follow these steps:
diff --git a/docs/getting-started/configure-coderabbit.md b/docs/getting-started/configure-coderabbit.md
@@ -1,11 +1,9 @@
 ---
-title: Configure CodeRabbit
-sidebar_label: Configure
+title: Add a configuration file
 description:
   CodeRabbit offers various configuration options to tailor the reviews to your
   specific requirements. Configuration can be made using one of the below
   options.
-sidebar_position: 2
 ---
 
 ```mdx-code-block
diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md
@@ -19,7 +19,7 @@ When you complete this tutorial, you'll have seen CodeRabbit's code-review featu
 For a more general overview of CodeRabbit, see [Introduction](/).
 
 :::note
-While this tutorial focuses on GitHub, CodeRabbit also works with GitLab, Azure DevOps, and Bitbucket. For more information, see [Supported Git Platforms](/platforms/).
+While this tutorial focuses on GitHub, CodeRabbit also works with GitLab, Azure DevOps, and Bitbucket. For more information, see [Integrate with Git platforms](/platforms/).
 :::
 
 ## Before you begin
@@ -44,6 +44,9 @@ To add CodeRabbit to your test repository, follow these steps:
 1. Select the **Only select repositories** radio button.
 1. From the **Select repositories** menu, select the `coderabbit-test` repository that you created earlier in this Quickstart.
 1. Click **Install & Authorize**.
+   :::note
+   CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai).
+   :::
 1. If a CodeRabbit **Complete your signup** dialog appears, then fill it out with the requested information before continuing.
 
 CodeRabbit is now ready to use with your test repository. The next steps demonstrate its core code-review features.
diff --git a/docs/getting-started/subscription-management.md b/docs/getting-started/subscription-management.md
@@ -1,8 +1,6 @@
 ---
-title: Subscription Management
+title: Manage your subscription
 description: Learn how to manage your CodeRabbit subscription, including billing, plan changes, and seat management
-sidebar_label: Subscription Management
-sidebar_position: 7
 ---
 
 This guide covers how to manage your subscription, including accessing billing information, changing plans, and adjusting your seat count.
diff --git a/docs/getting-started/support.md b/docs/getting-started/support.md
@@ -1,8 +1,6 @@
 ---
-title: Support
-sidebar_label: Support
+title: Get support
 description: Get help with CodeRabbit and find answers to common questions.
-sidebar_position: 3
 ---
 
 Welcome to CodeRabbit Support. Please refer to the following sections for
diff --git a/docs/getting-started/upgrading-permissions.md b/docs/getting-started/upgrading-permissions.md
@@ -1,8 +1,6 @@
 ---
-title: Upgrading App Permissions
+title: Set permissions
 description: Learn how to upgrade CodeRabbit's GitHub App permissions when new features are added
-sidebar_label: Upgrading Permissions
-sidebar_position: 6
 ---
 
 Sometimes when we add new features to CodeRabbit, we need to request additional GitHub permissions. If you see a warning about permissions or resources not being accessible, you'll need to approve the new permissions. Here's how to do it:
diff --git a/docs/guides/agent_chat.md b/docs/guides/agent_chat.md
@@ -1,8 +1,6 @@
 ---
-title: Chat and Agentic Chat
-sidebar_label: Chat and Agentic Chat
+title: Discuss code reviews with CodeRabbit
 description: Learn about CodeRabbit Pro's chat and agentic chat system
-sidebar_position: 3
 ---
 
 # CodeRabbit Chat
diff --git a/docs/guides/commands.md b/docs/guides/commands.md
@@ -1,8 +1,6 @@
 ---
-title: Commands
-sidebar_label: Commands
+title: Control and manage code reviews
 description: Learn how to control CodeRabbit using commands in pull request comments
-sidebar_position: 1
 ---
 
 # CodeRabbit Commands
diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
@@ -1,8 +1,6 @@
 ---
-title: Custom Reports
-sidebar_label: Custom Reports
+title: Customize reports
 description: Learn how to create custom reports with CodeRabbit Pro's flexible reporting system
-sidebar_position: 8
 ---
 
 ```mdx-code-block
@@ -78,6 +76,11 @@ Contained within the `<pr_details>` tag.
 - `State`: string ("open"/"closed") - Current state of the PR
 - `Mergeable`: boolean (true/false) - Whether the PR can be merged
 - `Is stale`: boolean - Whether PR has been inactive for over 168 hours
+- `PR Stage`: string - The current stage of open PRs in Open or Draft state, can be one of:
+  - "Needs Author Action" - PR requires author attention due to merge conflicts, draft status, or requested changes
+  - "Waiting for Author to Merge" - PR has approvals and is ready for author to merge
+  - "Waiting for Code Reviews" - PR is waiting for reviewers to approve
+  - undefined - PR is not in an open state (is merged or closed)
 
 #### Basic Information
 
@@ -126,60 +129,65 @@ Generate a summary of each pull request in the following bullet point format:
   - If 'Merged: true' set 'PR State: 🔀 Merged'
   - Else If 'Draft: true' set 'PR State: 📝 Draft'
   - Else If 'State: open' or 'State: active' set 'PR State: 💬 Open'
-  - Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
+  - Else If 'State: closed' or 'State: DECLINED' and 'Merged: false' set 'PR State: 🔒 Closed'
   - Else set 'PR State: ❓ Unknown'
   - If the PR is stale, add '⚠️ Stale' at the end of the PR State.
-- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
+- Mergeable (if PR State is not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable' based on the "Mergeable: " value.
+- PR Stage (if PR State is not 'Merged'): Provide the stage of the PR based on the "PR Stage: " value.
 - Summary: In under 50 words provide a short summary of the PR.
 - Comments: In under 50 words provide a short summary of all comments found within <pr_comments>, including each comments author username from <comment_author_username>. If there are no comments available, output 'No comments'.
 </overall_instructions>
 
 <example>
 - **PR Link:** [#3001](https://github.com/mygithuborg/myrepo/pull/3001)
-- **Title:** [PR Title]
+- **Title:** PR Title
 - **PR State:** 💬 Open
 - **Mergeable:** Mergeable
-- **Summary:** [Summary of the PR].
-- **Comments:** [Summary of the PR comments].
+- **PR Stage:** Waiting for Code Reviews
+- **Summary:** Summary of the PR.
+- **Comments:** Summary of the PR comments or No comments.
 
 - **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302)
-- **Title:** [PR Title]
+- **Title:** PR Title
 - **PR State:** 💬 Open
 - **Mergeable:** Mergeable
-- **Summary:** [Summary of the PR].
-- **Comments:** [Summary of the PR comments].
+- **PR Stage:** Waiting for Author to Merge
+- **Summary:** Summary of the PR.
+- **Comments:** Summary of the PR comments or No comments.
 
 - **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3)
-- **Title:** [PR Title]
+- **Title:** PR Title
 - **PR State:** 🔀 Merged
-- **Summary:** [Summary of the PR].
-- **Comments:** [Summary of the PR comments].
+- **Summary:** Summary of the PR.
+- **Comments:** Summary of the PR comments or No comments.
 
 - **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14)
-- **Title:** [PR Title]
+- **Title:** PR Title
 - **PR State:** 💬 Open
 - **Mergeable:** Mergeable
-- **Summary:** [Summary of the PR].
-- **Comments:** [Summary of the PR comments].
+- **PR Stage:** Needs Author Action
+- **Summary:** Summary of the PR.
+- **Comments:** Summary of the PR comments or No comments.
 
 - **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005)
-- **Title:** [PR Title]
+- **Title:** PR Title
 - **PR State:** 🔀 Merged
-- **Summary:** [Summary of the PR].
-- **Comments:** [Summary of the PR comments].
+- **Summary:** Summary of the PR.
+- **Comments:** Summary of the PR comments or No comments.
 
 - **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006)
-- **Title:** [PR Title]
+- **Title:** PR Title
 - **PR State:** 🔀 Merged
-- **Summary:** [Summary of the PR].
-- **Comments:** [Summary of the PR comments].
+- **Summary:** Summary of the PR.
+- **Comments:** Summary of the PR comments or No comments.
 
 - **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007)
-- **Title:** [PR Title]
+- **Title:** PR Title
 - **PR State:** 📝 Draft
 - **Mergeable:** Not Mergeable
-- **Summary:** [Summary of the PR].
-- **Comments:** [Summary of the PR comments].
+- **PR Stage:** Needs Author Action
+- **Summary:** Summary of the PR.
+- **Comments:** Summary of the PR comments or No comments.
 </example>
 ```
 
diff --git a/docs/guides/issue-chat.md b/docs/guides/issue-chat.md
@@ -1,8 +1,6 @@
 ---
-title: Issue Chat
-sidebar_label: Issue Chat
+title: Discuss issues and plan solutions
 description: Learn how to use CodeRabbit's chat capabilities within issues
-sidebar_position: 4
 ---
 
 ```mdx-code-block
diff --git a/docs/guides/issue-creation.md b/docs/guides/issue-creation.md
@@ -1,8 +1,6 @@
 ---
-title: Issue Creation
-sidebar_label: Issue Creation
+title: Create issues
 description: Learn how to create issues directly through CodeRabbit
-sidebar_position: 5
 ---
 
 ```mdx-code-block
diff --git a/docs/guides/linked-issues.md b/docs/guides/linked-issues.md
@@ -1,8 +1,6 @@
 ---
-title: Linked Issues
-sidebar_label: Linked Issues
+title: Work with linked Issues
 description: Learn how to effectively use linked issues with CodeRabbit for better pull request assessments
-sidebar_position: 6
 ---
 
 # Linked Issues
@@ -170,6 +168,6 @@ Only the issue title and description are considered in the assessment. Comments
 
 ## Related Resources
 
-- [Review Instructions](./review-instructions.md)
+- [Add review instructions](/guides/review-instructions)
 - [Issue Chat](./issue-chat.md)
 - [Issue Creation](./issue-creation.md)
diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md
@@ -1,8 +1,6 @@
 ---
-title: On-demand Reports
-sidebar_label: On-demand Reports
+title: Generate reports
 description: CodeRabbit offers a way to generate on-demand reports using a simple API request
-sidebar_position: 9
 ---
 
 ```mdx-code-block
diff --git a/docs/guides/review-instructions.md b/docs/guides/review-instructions.md
@@ -1,11 +1,9 @@
 ---
-title: Review Instructions
-sidebar_label: Review Instructions
+title: Add review instructions
 description:
   CodeRabbit offers various customization options to tailor the reviews to your
   specific requirements. Customizations can be made using one of the below
   options.
-sidebar_position: 2
 ---
 
 The guide explains how to add custom review instructions for the entire project.
diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md
@@ -1,8 +1,6 @@
 ---
-title: Scheduled Reports
-sidebar_label: Scheduled Reports
+title: Schedule reports
 description: Learn how to set up automated recurring reports with CodeRabbit Pro
-sidebar_position: 7
 ---
 
 ```mdx-code-block
diff --git a/docs/integrations/code-graph-analysis.md b/docs/integrations/code-graph-analysis.md
@@ -1,8 +1,6 @@
 ---
-title: Code Graph Analysis
+title: Analyze your code changes
 description: Learn about CodeRabbit's intelligent graph-based code analysis.
-sidebar_label: Code Graph Analysis
-sidebar_position: 6
 ---
 
 # CodeRabbit Code Graph Analysis
diff --git a/docs/integrations/issue-integrations.md b/docs/integrations/issue-integrations.md
@@ -1,8 +1,6 @@
 ---
-title: Issue Integrations
+title: Integrate issue tracking
 description: Learn about CodeRabbit's integrations with issue tracking systems like Jira and Linear.
-sidebar_label: Issue Integrations
-sidebar_position: 5
 ---
 
 CodeRabbit integrates with popular issue tracking systems to provide context from linked and related issues while reviewing code.
diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md
@@ -1,8 +1,6 @@
 ---
-title: Knowledge Base
+title: Apply your code review preferences
 description: Learn about CodeRabbit's internal knowledge base and its integrations with external services.
-sidebar_label: Knowledge Base
-sidebar_position: 4
 ---
 
 CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience.
diff --git a/docs/overview/introduction.md b/docs/overview/introduction.md
diff --git a/docs/platforms/github-com.md b/docs/platforms/github-com.md
diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md
diff --git a/docs/tools/oxlint.md b/docs/tools/oxlint.md
diff --git a/docs/tools/pipeline-remediation.md b/docs/tools/pipeline-remediation.md
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
diff --git a/sidebars.ts b/sidebars.ts
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
