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
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
Small fixes
  • Loading branch information
jmacdotorg committed May 21, 2025
commit c20141ceaa2bf3363bd9cb223b978716a1bb745e
5 changes: 2 additions & 3 deletions docs/guides/code-review-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ 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
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,
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.
Expand Down Expand Up @@ -86,7 +85,7 @@ For more information, see [Control and manage code reviews](/guides/commands).

You can command CodeRabbit to generate improvements to the branch under review.
CodeRabbit accomplishes this by publishing a new branch based on the branch under review,
and cerating a new pull request for your own review.
and creating a new pull request for your own review.

Available code-generation commands let you request the following from CodeRabbit:

Expand Down
11 changes: 5 additions & 6 deletions docs/guides/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For a complete CodeRabbit command reference, see [Code review command reference]
## Control the flow of code reviews {#flow}

By default, CodeRabbit automatically reviews every new pull request created in
your repository. It updates its review with with comments whenever the pull request has new commits
your repository. It updates its review with comments whenever the pull request has new commits
pushed to it.

The following sections show you how to tell CodeRabbit to modify this behavior with
Expand Down Expand Up @@ -72,8 +72,7 @@ two types:
- A _full review_ disregards any comments that CodeRabbit has already made
on this pull request, and generates a complete review of the entire pull request.

- An _incremental review_ takes all comments that CodeRabbit has made since
its most recent full review into consideration, and
- An _incremental review_ takes all comments that CodeRabbit has made since its most recent full review into consideration, and generates a review of only the new changes.

To manually request a full review, post the following comment to the
pull request:
Expand Down Expand Up @@ -103,7 +102,7 @@ pull request:
The commands in this section request CodeRabbit to display its own configuration
or documentation.

### Display current configutation {#config}
### Display current configuration {#config}

To have CodeRabbit post a comment listing out its current configuration
with your repository, post the following comment to the
Expand All @@ -115,7 +114,7 @@ pull request:

### Display a quick-reference guide {#help}

To have CodeRabbit post a comment to the pull review with a quick-reference
To have CodeRabbit post a comment to the pull request with a quick-reference
guide to its own commands and other features, post the following comment to the
pull request:

Expand All @@ -127,4 +126,4 @@ pull request:

- [Generate code improvements](/guides/generate-improvements)
- [Best practices](/guides/code-review-best-practices)
- [Tips and troubleshooting](/guides/code-review-tips-and-troubleshooting)
- [Troubleshooting](/guides/code-review-troubleshooting)
9 changes: 5 additions & 4 deletions docs/guides/generate-improvements.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ your workflow.

For a complete CodeRabbit command reference, see [Code review command reference](/reference/review-commands).

### Genearate inline documentation {#docstrings}
### Generate inline documentation {#docstrings}

To have CodeRabbit generate missing documentation for function code added by
the pull request, post the following comment to the
pull request:

```
@coderabbitai docstrings
@coderabbitai generate docstrings
```

For more information about how CodeRabbit can generate inline documentation, including
Expand All @@ -64,7 +64,8 @@ pull request:
@coderabbitai plan
```

## What's next
## What's next {#whats-next}

- [Control and manage code reviews](/guides/commands)
- [Best practices](/guides/code-review-best-practices)
- [Tips and troubleshooting](/guides/code-review-tips-and-troubleshooting)
- [Troubleshooting](/guides/code-review-troubleshooting)