Skip to content

Expand and refactor the code-review docs #355

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 13 commits into from
May 23, 2025
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
A few rewords, on Aravind's suggestion.
  • Loading branch information
jmacdotorg committed May 23, 2025
commit 4b5263e20069f585b4f5c28eecbf592f92f18152
10 changes: 3 additions & 7 deletions docs/guides/code-review-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: An overview of CodeRabbit's core code review features.
sidebar_label: Overview
---

One of the core features of CodeRabbit is its ability to proactively review
The central feature of CodeRabbit is its ability to proactively review
new pull requests on your code repository.

CodeRabbit reviews take the form of pull request comments that
Expand All @@ -23,15 +23,11 @@ A CodeRabbit code review consists of a single, multi-part comment attached to th
The comment contains a detailed summary and analysis of the changes,
as well as a listing of problems or areas for potential improvement that it found.

CodeRabbit uses a variety of open-source linters and security tools to provide this analysis. CodeRabbit
also consults a number of large language models (LLMs) to further analyze and critique the proposed changes,
CodeRabbit uses [a variety of open-source linters and security tools](/tools) to provide this analysis. CodeRabbit
also consults an ensemble of models to further analyze and critique the proposed changes,
using all of the content of your repository as context. The code-review comment that CodeRabbit attaches
to your pull request synthesizes and summarizes all of the information collected from these different sources.

For more information
on the open-source tools that CodeRabbit applies and how you can configure its use of them,
see [Configure third-party tool use](/tools).

For more information about the graph analysis that CodeRabbit includes with its reviews
when available, see [CodeRabbit Code Graph Analysis](/integrations/code-graph-analysis).

Expand Down