You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/platforms/jiasu.xzqcsaa.nyc.mn.md
+10-8
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ sidebar_position: 1
7
7
8
8
This is a step-by-step guide to integrate CodeRabbit with your GitHub repositories.
9
9
10
-
> **CodeRabbit** is an AI code reviewer designed to ease the challenges of code review, supporting repository maintainers and teams. It not only reviews your PRs but also provides concise summaries, identifies potential issues, and offers insights that might be missed during manual reviews.
10
+
> **CodeRabbit** is an AI code reviewer designed to ease the challenges of code review, supporting repository maintainers and teams. It reviews your PRs and provides concise summaries, identifies potential issues, and offers insights that might be missed during manual reviews.
11
11
12
12
## How CodeRabbit Works?
13
13
@@ -21,13 +21,13 @@ It preprocesses the PR content, builds context, leverages Large Language Models
21
21
22
22
### 1. Accessing CodeRabbit
23
23
24
-
Visit the [Code Rabbit login](https://app.coderabbit.ai/login?free-trial) page. You'll see all the authentication options, select "**Login with GitHub**" to proceed.
24
+
Visit the [CodeRabbit login](https://app.coderabbit.ai/login?free-trial) page. You'll see all the authentication options, select "**Login with GitHub**" to proceed.
When you choose **Login with GitHub** in step1, you'll be prompted to authorize CodeRabbit.
30
+
When you choose **Login with GitHub** in step1, you'll be prompted to authorize CodeRabbit.
31
31
32
32
> This step grants the necessary permissions for CodeRabbit to interact with your repositories and pull requests.
33
33
@@ -55,13 +55,15 @@ If you opt to authorize all repositories during setup, CodeRabbit will automatic
55
55
56
56
You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login).
57
57
58
-
You can tailor CodeRabbit's functionality using the coderabbit.yaml file, which you place directly in your GitHub repository. This file mirrors the options available in the CodeRabbit user interface, with each setting in the YAML corresponding to a specific toggle in the UI. Configure CodeRabbit either through the coderabbit.yaml file or the interface, depending on your preference.
58
+
You can tailor CodeRabbit's functionality using the `.coderabbit.yaml` file, which you place directly in your GitHub repository. This file mirrors the options available in the CodeRabbit user interface, with each setting in the YAML corresponding to a specific toggle in the UI. Configure CodeRabbit either through the coderabbit.yaml file or the interface, depending on your preference.
59
59
60
60
:::note
61
-
If a coderabbit.yaml file exists in your GitHub repository, it takes precedence over any UI settings. Choose either the YAML file or UI configuration - you don't need to use both. **Refer Coderabbit.yaml schema [here](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json)**
61
+
62
+
If a `.coderabbit.yaml` file exists in your GitHub repository, it takes precedence over any UI settings. Choose either the YAML file or UI configuration - you don't need to use both. **Refer CodeRabbit YAML schema [here](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json)**
63
+
62
64
:::
63
65
64
-
Once your coderabbit.yaml file is prepared according to your needs, simply place it in your GitHub repository, and you're all set—CodeRabbit is now integrated.
66
+
Once your `.coderabbit.yaml` file is prepared according to your needs, simply place it in your GitHub repository, and you're all set — CodeRabbit is now integrated.
65
67
66
68
> When a pull request is created targeting the master branch, CodeRabbit automatically initiates its review process. It analyzes the changes and generates a summary and walkthrough of the modifications. The specific feedback and analysis provided by CodeRabbit are determined by the options you've configured in your YAML file.
67
69
@@ -89,15 +91,15 @@ The sequence diagram illustrates the precise flow of interactions between the ob
Also check out the response when i asked for what improvements can be done on the code level
94
+
Also, check out the response when asked for what improvements can be done on the code level.
93
95
94
96

95
97
96
98
In addition to providing reviews and summaries, **CodeRabbit** can also detect configuration issues.
97
99
98
100
> For example, I accidentally set up both CodeRabbit Pro (The process we've been discussing) and the open-source version (Refer to [different config process](https://github.com/coderabbitai/ai-pr-reviewer?tab=readme-ov-file#install-instructions)) in my repository at the same time.
99
101
100
-
Interestingly, CodeRabbit automatically detects and alerts you about configuration conflicts.
102
+
CodeRabbit automatically detects and alerts you about configuration conflicts.
101
103
102
104

0 commit comments