Skip to content

Reorganize and expand the Introduction page #297

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.

Sign up for GitHub

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 6 commits into from
Apr 29, 2025
Merged

Reorganize and expand the Introduction page #297

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
967486f
Reorganize and expand the Introduction page, putting more emphasis on…
jmacdotorg Apr 23, 2025
f8250f2
Attending to CR critiques.
jmacdotorg Apr 23, 2025
a9e4e86
More tweaks
jmacdotorg Apr 24, 2025
a8829b5
Swap out imperatve-verb headers (which might accidentally mislead rea…
jmacdotorg Apr 24, 2025
45b3dec
Merge branch 'main' into overview
aravindputrevu Apr 29, 2025
21be545
Remove unnecessary sub-head.
jmacdotorg Apr 29, 2025
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
Swap out imperatve-verb headers (which might accidentally mislead rea… 
…ders into expecting instructions) for noun-phrase headers.
  • Loading branch information
@jmacdotorg
jmacdotorg committed Apr 24, 2025
commit a8829b535abb02adddd839d674fe088547fbac4b
6 changes: 3 additions & 3 deletions docs/overview/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ Core CodeRabbit features include the following:
- Practices strong privacy and security, with no retention of analyzed code.
- Offers free use for public repositories, and flexible pricing for private codebases.

## Add CodeRabbit to your existing workflow
## Seamless workflow integration

CodeRabbit shares its reviews as comments attached to pull requests, using the same Git platform that your team already uses. Further commits in the same pull review prompt CodeRabbit to make further reviews, using the earlier reviews as context.

Each time that it performs a code review, CodeRabbit runs the relevant code changes through [an array of industry-standard code linters, security analyzers, and other tools](/tools/). CodeRabbit synthesizes the output of these tools into its reviews, offering a high-level analysis that can suggest areas for further focus and improvement.

Your team can have conversations with CodeRabbit about its reviews by replying to it with follow-up comments on pull requests, asking it questions or making observations about the review using natural language. CodeRabbit continues the conversation appropriately, offering further insights about the code changes, or adjusting its own review style based on feedback.

### Teach CodeRabbit your team preferences
### Customizable review preferences

As you interact with CodeRabbit through chat, it learns the review preferences of your team, and applies them to all future reviews on a given repository.

Expand All @@ -56,7 +56,7 @@ If you need to fine-tune CodeRabbit's behavior beyond this, then you can [add a

No matter how you tune and customize CodeRabbit, its default settings make it useful out of the box, able to meaningfully review pull requests within minutes of its introduction to a repository.

### Integrate CodeRabbit with your Git platform
### Platform integration options

CodeRabbit integrates in just a few clicks with many popular Git platforms:

Expand Down