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
tweaks
  • Loading branch information
jmacdotorg committed May 23, 2025
commit 7dd02e9275545c62bbd8ed1696579241f1ea882a
2 changes: 1 addition & 1 deletion docs/guides/code-review-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ These interactions can serve several purposes:
### Chat with CodeRabbit {#chat}

You can have open-ended, natural-language discussion with CodeRabbit during a code review, treating it
as an LLM-powered chat bot that has your entire code repository available for context. For more information, see [CodeRabbit Chat](/guides/agent_chat).
as an LLM-powered chatbot that has your entire code repository available for context. For more information, see [CodeRabbit Chat](/guides/agent_chat).

### Manage CodeRabbit review behavior {#manage}

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/generate-improvements.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ such as with the following examples:
- `@coderabbitai Add input validation with proper error messages to these new functions.`
- `@coderabbitai Break this large function into smaller, more focused methods.`

Beyond this kind of free-form request, you can also give CodeRabbit keyword-based
In addition to this kind of free-form request, you can also give CodeRabbit keyword-based
commands for common code-generation requests, as described in [Code generation commands](#commands).
This includes the `plan` keyword, which acts as shorthand for the first prompt on the
previous list.
Expand Down