From 7c8e9f3a53e39e8fca8c224623a5134a1463d20b Mon Sep 17 00:00:00 2001 From: alex Date: Sat, 31 May 2025 15:17:44 -0400 Subject: [PATCH 1/6] adding more context so pylon doesnt get confused --- docs/faq.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docs/faq.md b/docs/faq.md index 4d66b196..e8c5fbdf 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -10,6 +10,44 @@ import TabItem from '@theme/TabItem'; ## General Questions {#general-questions} +### How to trigger a CodeRabbit Review? + +Once installed CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repostiory. This branch restriction can be customized in your settings. + +You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](./commands.md) for full list): + +- `@coderabbitai review` - Triggers a standard review +- `@coderabbitai full review` - Triggers a comprehensive review + +### How to run a review from my IDE? + +You can trigger CodeRabbit reviews directly from your IDE using our editor plugins: + +- [VS Code Extension](./integrations/vscode.md) - For Visual Studio Code users +- [Cursor Plugin](./integrations/cursor.md) - For Cursor editor users +- [WindSurf Extension](./integrations/windsurf.md) - For WindSurf IDE users + +These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions. + +### How to install CodeRabbit? + +View step by step instructions depending on your platform: + + + + See our [GitHub App installation guide](./installation/github.md) for step-by-step instructions. + + + Follow our [GitLab integration guide](./installation/gitlab.md) to get started. + + + Check out the [Bitbucket installation steps](./installation/bitbucket.md) for detailed setup. + + + View our [Azure DevOps setup guide](./installation/azure.md) for complete installation instructions. + + + ### How accurate is CodeRabbit? > CodeRabbit demonstrates high accuracy in code reviews based on early adoption results. While 100% accuracy isn't guaranteed due to AI's evolving nature, our technology continuously improves through: From e9519660abd3794db04ffb6f4da85c54d730286c Mon Sep 17 00:00:00 2001 From: alex Date: Sat, 31 May 2025 15:19:36 -0400 Subject: [PATCH 2/6] more fixes --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index e8c5fbdf..51af331d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; ### How to trigger a CodeRabbit Review? -Once installed CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repostiory. This branch restriction can be customized in your settings. +Once installed, CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repository. We automatically detect the name of the primary branch (whether this be master, main, dev, etc). This branch restriction can be customized in your settings. You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](./commands.md) for full list): From 2c1b6be2f9566d1842bc271d468738e933271dde Mon Sep 17 00:00:00 2001 From: alex Date: Sat, 31 May 2025 15:26:53 -0400 Subject: [PATCH 3/6] add notes on reporting vs reviewing --- docs/faq.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/docs/faq.md b/docs/faq.md index 51af331d..daa35205 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -65,6 +65,51 @@ CodeRabbit works with all programming languages, with varying proficiency based - Available training data - Community usage patterns +### Whats the difference between CodeRabbit Code Reviews and CodeRabbit Reports? + +CodeRabbit offers two distinct features that serve different roles in your development workflow: + +#### CodeRabbit Code Reviews + +**Role**: Developer, QA, and Code Reviewer +**Access Level**: Full code access with comprehensive analysis capabilities + +**Key Features:** + +- **Complete Toolchain**: Runs all available analysis tools on your codebase +- **Static Analysis**: Can execute shell commands and perform deep static analysis against your codebase +- **Direct Code Access**: Has full access to code in issues and pull requests +- **Interactive Chat**: Provides chat features for real-time collaboration and questions +- **Comprehensive Review**: Analyzes code quality, security, performance, and best practices +- **Actionable Feedback**: Provides specific, line-by-line suggestions and improvements +- **Comment Interaction**: Engages with users through comments in pull requests and issues for clarifications and discussions +- **Available in All Tiers**: All features are available across Free, Lite, and Pro plans + +#### CodeRabbit Reports + +**Role**: Project Manager and Communication Hub +**Access Level**: Summary-only access without direct code interaction + +**Key Features:** + +- **Summary Generation**: Creates convenient, formatted summaries of all your recent pull requests +- **Customizable Prompts**: Allows you to select or create your own summarization templates +- **High-Level Overview**: Focuses on project progress and changes without code details +- **Comment Analysis**: Reads and summarizes existing comments and discussions +- **No Code Access**: Operates only on summaries and metadata, not the actual codebase +- **Communication Tool**: Designed for stakeholders who need updates without technical details +- **Multi-Channel Delivery**: Sends reports through various communication channels: + - Email notifications + - Slack integration + - Discord webhooks + - Microsoft Teams updates +- **Pro Plan Exclusive**: Reports feature is available only in the Pro plan tier + +**In Summary:** + +- **Code Reviews** = Technical analysis with full code access for developers +- **Reports** = High-level summaries with no code access for project management + ### Data Security From fc5056a2de625d5194e7885409f8eecf5cabf876 Mon Sep 17 00:00:00 2001 From: alex Date: Sat, 31 May 2025 15:31:20 -0400 Subject: [PATCH 4/6] fix link --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index daa35205..e3bb3785 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem'; Once installed, CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repository. We automatically detect the name of the primary branch (whether this be master, main, dev, etc). This branch restriction can be customized in your settings. -You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](./commands.md) for full list): +You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](./guides/commands.md) for full list): - `@coderabbitai review` - Triggers a standard review - `@coderabbitai full review` - Triggers a comprehensive review From 3a386a97876d14cce6cbd74ea06310fa58037649 Mon Sep 17 00:00:00 2001 From: alex Date: Sat, 31 May 2025 15:34:37 -0400 Subject: [PATCH 5/6] fix more links --- docs/faq.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index e3bb3785..5d27d9c7 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -23,9 +23,7 @@ You can also manually trigger a review at any time by commenting on a pull reque You can trigger CodeRabbit reviews directly from your IDE using our editor plugins: -- [VS Code Extension](./integrations/vscode.md) - For Visual Studio Code users -- [Cursor Plugin](./integrations/cursor.md) - For Cursor editor users -- [WindSurf Extension](./integrations/windsurf.md) - For WindSurf IDE users +- [VSCode Extension](./guides/about-vscode.md) - For VSCode, Cursor or Windsurf users These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions. From ecd10fb4c808671e109f5a368dfcfe5e3410375b Mon Sep 17 00:00:00 2001 From: alex Date: Sat, 31 May 2025 15:37:30 -0400 Subject: [PATCH 6/6] fix more links --- docs/faq.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 5d27d9c7..8e5de723 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem'; Once installed, CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repository. We automatically detect the name of the primary branch (whether this be master, main, dev, etc). This branch restriction can be customized in your settings. -You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](./guides/commands.md) for full list): +You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](/guides/commands.md) for full list): - `@coderabbitai review` - Triggers a standard review - `@coderabbitai full review` - Triggers a comprehensive review @@ -33,16 +33,16 @@ View step by step instructions depending on your platform: - See our [GitHub App installation guide](./installation/github.md) for step-by-step instructions. + See our [GitHub App installation guide](./platforms/github-com.md) for step-by-step instructions. - Follow our [GitLab integration guide](./installation/gitlab.md) to get started. + Follow our [GitLab integration guide](/platforms/gitlab-com.mdx) to get started. - Check out the [Bitbucket installation steps](./installation/bitbucket.md) for detailed setup. + Check out the [Bitbucket installation steps](/platforms/bitbucket-cloud.md) for detailed setup. - View our [Azure DevOps setup guide](./installation/azure.md) for complete installation instructions. + View our [Azure DevOps setup guide](/platforms/azure-devops.md) for complete installation instructions. @@ -173,7 +173,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.md) - **Branch Selection**: Default branch reviews enabled by default (configurable) ### Access & Permissions @@ -189,7 +189,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.md) :::tip Collaboration Mode When team members are active in PRs, use `@coderabbitai` to engage the bot. @@ -227,7 +227,7 @@ The following limits enforced _per developer_: 3. That's it. CodeRabbit will automatically start reviewing your PRs :::tip Need Help? -Visit our [Support](/getting-started/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit). +Visit our [Support](/getting-started/support.md) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit). ::: #### Unable to View Repositories in GitLab