Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 946dec5

Browse files
Fix/faq pylon (#370)
* adding more context so pylon doesnt get confused * more fixes * add notes on reporting vs reviewing * fix link * fix more links * fix more links
1 parent 42a07ca commit 946dec5

File tree

1 file changed

+84
-3
lines changed

1 file changed

+84
-3
lines changed

docs/faq.md

Lines changed: 84 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,42 @@ import TabItem from '@theme/TabItem';
1010

1111
## General Questions {#general-questions}
1212

13+
### How to trigger a CodeRabbit Review?
14+
15+
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.
16+
17+
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):
18+
19+
- `@coderabbitai review` - Triggers a standard review
20+
- `@coderabbitai full review` - Triggers a comprehensive review
21+
22+
### How to run a review from my IDE?
23+
24+
You can trigger CodeRabbit reviews directly from your IDE using our editor plugins:
25+
26+
- [VSCode Extension](./guides/about-vscode.md) - For VSCode, Cursor or Windsurf users
27+
28+
These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions.
29+
30+
### How to install CodeRabbit?
31+
32+
View step by step instructions depending on your platform:
33+
34+
<Tabs>
35+
<TabItem value="github" label="GitHub" default>
36+
See our [GitHub App installation guide](./platforms/github-com.md) for step-by-step instructions.
37+
</TabItem>
38+
<TabItem value="gitlab" label="GitLab">
39+
Follow our [GitLab integration guide](/platforms/gitlab-com.mdx) to get started.
40+
</TabItem>
41+
<TabItem value="bitbucket" label="Bitbucket">
42+
Check out the [Bitbucket installation steps](/platforms/bitbucket-cloud.md) for detailed setup.
43+
</TabItem>
44+
<TabItem value="azure" label="Azure DevOps">
45+
View our [Azure DevOps setup guide](/platforms/azure-devops.md) for complete installation instructions.
46+
</TabItem>
47+
</Tabs>
48+
1349
### How accurate is CodeRabbit?
1450

1551
> 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:
@@ -27,6 +63,51 @@ CodeRabbit works with all programming languages, with varying proficiency based
2763
- Available training data
2864
- Community usage patterns
2965

66+
### Whats the difference between CodeRabbit Code Reviews and CodeRabbit Reports?
67+
68+
CodeRabbit offers two distinct features that serve different roles in your development workflow:
69+
70+
#### CodeRabbit Code Reviews
71+
72+
**Role**: Developer, QA, and Code Reviewer
73+
**Access Level**: Full code access with comprehensive analysis capabilities
74+
75+
**Key Features:**
76+
77+
- **Complete Toolchain**: Runs all available analysis tools on your codebase
78+
- **Static Analysis**: Can execute shell commands and perform deep static analysis against your codebase
79+
- **Direct Code Access**: Has full access to code in issues and pull requests
80+
- **Interactive Chat**: Provides chat features for real-time collaboration and questions
81+
- **Comprehensive Review**: Analyzes code quality, security, performance, and best practices
82+
- **Actionable Feedback**: Provides specific, line-by-line suggestions and improvements
83+
- **Comment Interaction**: Engages with users through comments in pull requests and issues for clarifications and discussions
84+
- **Available in All Tiers**: All features are available across Free, Lite, and Pro plans
85+
86+
#### CodeRabbit Reports
87+
88+
**Role**: Project Manager and Communication Hub
89+
**Access Level**: Summary-only access without direct code interaction
90+
91+
**Key Features:**
92+
93+
- **Summary Generation**: Creates convenient, formatted summaries of all your recent pull requests
94+
- **Customizable Prompts**: Allows you to select or create your own summarization templates
95+
- **High-Level Overview**: Focuses on project progress and changes without code details
96+
- **Comment Analysis**: Reads and summarizes existing comments and discussions
97+
- **No Code Access**: Operates only on summaries and metadata, not the actual codebase
98+
- **Communication Tool**: Designed for stakeholders who need updates without technical details
99+
- **Multi-Channel Delivery**: Sends reports through various communication channels:
100+
- Email notifications
101+
- Slack integration
102+
- Discord webhooks
103+
- Microsoft Teams updates
104+
- **Pro Plan Exclusive**: Reports feature is available only in the Pro plan tier
105+
106+
**In Summary:**
107+
108+
- **Code Reviews** = Technical analysis with full code access for developers
109+
- **Reports** = High-level summaries with no code access for project management
110+
30111
### Data Security
31112

32113
<Tabs>
@@ -92,7 +173,7 @@ Email field and click Update to save your changes.
92173
### Usage and Configuration
93174

94175
- **Language Settings**: Configure review language in repository settings
95-
- **Review Rules**: Customize via [review instructions](/guides/review-instructions)
176+
- **Review Rules**: Customize via [review instructions](/guides/review-instructions.md)
96177
- **Branch Selection**: Default branch reviews enabled by default (configurable)
97178

98179
### Access & Permissions
@@ -108,7 +189,7 @@ Interact with CodeRabbit by:
108189
1. Replying directly to CodeRabbit comments
109190
2. Tagging `@coderabbitai` in PR discussions
110191
3. Adding review comments for specific lines
111-
4. Customize via [review instructions](/guides/review-instructions)
192+
4. Customize via [review instructions](/guides/review-instructions.md)
112193

113194
:::tip Collaboration Mode
114195
When team members are active in PRs, use `@coderabbitai` to engage the bot.
@@ -146,7 +227,7 @@ The following limits enforced _per developer_:
146227
3. That's it. CodeRabbit will automatically start reviewing your PRs
147228

148229
:::tip Need Help?
149-
Visit our [Support](/getting-started/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
230+
Visit our [Support](/getting-started/support.md) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
150231
:::
151232

152233
#### Unable to View Repositories in GitLab

0 commit comments

Comments
 (0)