Skip to content

Update Documentation and Enhance Footer in CodeRabbit Project #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Dec 5, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: improve formatting for clarity in 'Why CodeRabbit' section
  • Loading branch information
aravindputrevu committed Dec 5, 2024
commit e4376998c1e71232206e79df2b7dd5b0cb2ebd4f
18 changes: 9 additions & 9 deletions docs/overview/why-coderabbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,30 +28,30 @@ What makes CodeRabbit truly valuable is its ability to learn and adapt to your t

CodeRabbit will then:

1. Remember this preference for future reviews
2. Apply this knowledge across the entire codebase
3. Share this learning with the whole team through its review comments
4. Maintain consistency with your established standards
- Remember this preference for future reviews
- Apply this knowledge across the entire codebase
- Share this learning with the whole team through its review comments
- Maintain consistency with your established standards

### Practical Impact on Your Workflow

When a developer opens a pull request, CodeRabbit:

1. Analyzes changes across the entire codebase context
2. Generates a clear, actionable summary
3. Creates visual sequence diagrams for complex changes
4. Provides specific feedback and suggestions
- Analyzes changes across the entire codebase context
- Generates a clear, actionable summary
- Creates visual sequence diagrams for complex changes
- Provides specific feedback and suggestions

This means human reviewers can focus on architectural decisions and knowledge sharing, rather than catching basic issues.

### Built for Production Teams

For teams building production software, CodeRabbit provides:

-
- SOC 2 Type II and GDPR compliance for enterprise security requirements
- Self-hosted deployment options for complete control
- Zero data retention policy - code is analyzed in memory and immediately discarded
- Fine-grained access controls for repository and organization management

Want to see the impact yourself? Try CodeRabbit on your next complex refactoring PR - you might be surprised at the subtle implications it catches that could easily be missed in manual review.

Expand Down
Loading