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
Show file tree
Hide file tree
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: enhance explanation of CodeRabbit's learning capabilities and a…
…dd visual aid
  • Loading branch information
aravindputrevu committed Dec 5, 2024
commit da29ec764f10e96ca9457e2545086a9e20d4565e
11 changes: 9 additions & 2 deletions docs/overview/why-coderabbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,16 @@ CodeRabbit combines the specialized insights of over 20 analysis tools (ESLint,

### Learning Your Team's DNA

What makes CodeRabbit truly valuable is its ability to become an extension of your team's knowledge:
What makes CodeRabbit truly valuable is its ability to learn and adapt to your team's codebase, practices, and standards. It doesn't just pattern match - it builds a deep understanding through direct interactions with your team. For example, when a reviewer indicates a preference:

// learnings screenshot
![CodeRabbit Learnings](/img/about/why-cr-learnings.png "How CodeRabbit learns and remembers org standards")

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

### Practical Impact on Your Workflow

Expand Down
Binary file added static/img/about/why-cr-learnings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading