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

Commit 2c1b6be

Browse files
add notes on reporting vs reviewing
1 parent e951966 commit 2c1b6be

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/faq.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,51 @@ CodeRabbit works with all programming languages, with varying proficiency based
6565
- Available training data
6666
- Community usage patterns
6767

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

70115
<Tabs>

0 commit comments

Comments
 (0)