Skip to content

Commit 533af1e

Browse files
karan925tyaga001
karan925
authored and
tyaga001
committed
Fix images for light and dark mode. Made improvements to docs (#22)
1 parent 8073a01 commit 533af1e

35 files changed

+78
-55
lines changed

‎docs/about/images/CodeRabbitFlow.png

-150 KB
Loading

‎docs/about/images/cr_seat_free_dark.png

296 KB
Loading

‎docs/about/images/cr_seat_free_light.png

301 KB
Loading

‎docs/about/images/cr_seat_manage_dark.png

298 KB
Loading

‎docs/about/images/cr_seat_manage_light.png

303 KB
Loading

‎docs/about/images/cr_support_help_dark.png

325 KB
Loading

‎docs/about/images/cr_support_help_light.png

151 KB
Loading

‎docs/about/images/cr_support_orgs_dark.png

262 KB
Loading

‎docs/about/images/cr_support_orgs_light.png

265 KB
Loading

‎docs/about/images/pricing.png

-71.9 KB
Binary file not shown.

‎docs/about/images/pricing2.png

-41.4 KB
Binary file not shown.

‎docs/faq/faq.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,14 @@ Yes, you can change it under the repository settings.
7474

7575
There are hourly rate limits for each developer per repository:
7676

77-
- Number of files reviewed per hour: 200
78-
- Number of reviews : 3 back to back reviews followed by 4 reviews/hour
79-
- Number of conversations: 25 back to back messages followed by 50 messages/hr
80-
77+
- Number of files reviewed per hour: 200
78+
- Number of reviews : 3 back to back reviews followed by 4 reviews/hour
79+
- Number of conversations: 25 back to back messages followed by 50 messages/hr
8180

8281
In-trial and open-source plans have lower rate limits than the paid plan. In all cases, we re-allow further reviews/conversations after a brief timeout.
8382

84-
Please note that we're continually innovating and enhancing our application with new capabilities. Stay tuned and follow us for updates as new exciting features are built. We're committed to making your experience with CodeRabbit even better.
83+
:::note
84+
We are continually innovating and enhancing our application with new capabilities. Stay tuned and follow us for updates as new exciting features are built. We're committed to making your experience with CodeRabbit even better.
85+
:::
8586

8687
If you have further questions or need additional information, don't hesitate to reach out to us at [[email protected]](mailto:[email protected]).

‎docs/get-started/add-repo.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,20 @@ To add additional repositories after the sign-up, go to the repositories page wi
2828

2929
Click on the "**Add repositories**" button. Upon clicking, you'll be redirected to GitHub.
3030

31-
![Untitled](./images/add1.png)
31+
![AddRepo](./images/cr_add_repo_light.png#gh-light-mode-only)
32+
![AddRepo](./images/cr_add_repo_dark.png#gh-dark-mode-only)
3233

3334
Upon successful installation, you will be automatically redirected back to the CodeRabbit UI. Here, you can view the list of repositories that CodeRabbit now has access to.
3435

35-
![Untitled](./images/add4.png)
36+
:::note
3637

37-
Note for GitLab the flow is slightly different. All the repositories display by default and you can toggle and enable the ones where the CodeRabbit app should be installed.
38+
For **GitLab** the flow is slightly different. All the repositories display by default and you can toggle and enable the ones where the CodeRabbit app should be installed.
39+
40+
![AddRepo](./images/cr_add_repo_gitlab_light.png#gh-light-mode-only)
41+
![AddRepo](./images/cr_add_repo_gitlab_dark.png#gh-dark-mode-only)
42+
43+
:::
3844

3945
### **Need help?**
4046

41-
If you require assistance, our support team is here to help. Simply click on the help icon within the CodeRabbit user interface. For more detailed information, please refer to the "Support" section. Additionally, consider joining the CodeRabbit Discord community to connect with other users and access a wealth of knowledge about using CodeRabbit effectively.
47+
If you require assistance, our support team is here to help. Simply click on the help icon within the CodeRabbit user interface. For more detailed information, please refer to the "Support" section. Additionally, consider joining the CodeRabbit **Discord** community to connect with other users and access a wealth of knowledge about using CodeRabbit effectively.

‎docs/get-started/analytics.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ slug: /dashboard
55
description: Accelerate Code Reviews with AI
66
image: "/preview_meta.jpg"
77
---
8+
89
<head>
910
<meta charSet="utf-8" />
1011
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
@@ -22,19 +23,21 @@ image: "/preview_meta.jpg"
2223
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
2324
</head>
2425

25-
CodeRabbit Dashboard displays organization's pull request activity and value provided by CodeRabbit reviews. This includes the number of pull requests reviewed, actionable items,optional comments and more.
26+
CodeRabbit Dashboard displays organization's pull request activity and value provided by CodeRabbit reviews. This includes the number of pull requests reviewed, actionable items, optional comments and more.
2627

2728
Dashboard displays the following information:
2829

2930
- **Pull Requests Overview:** View the number of pull requests reviewed by CodeRabbit per week, month, and year.
3031
- **CodeRabbit's Activity:** Understand the metrics related to the number of reviews conducted by CodeRabbit, actionable items, and optional suggestions.
3132

32-
![Untitled](./images/analytic2.png)
33+
![Untitled](./images/cr_dash_dark.png#gh-dark-mode-only)
34+
![Untitled](./images/cr_dash_light.png#gh-light-mode-only)
3335

34-
Access the list of recent pull request reviewed.
36+
Access the list of recent pull requests reviewed.
3537

36-
![Untitled](./images/analytic3.png)
38+
![Untitled](./images/cr_history_dark.png#gh-dark-mode-only)
39+
![Untitled](./images/cr_history_light.png#gh-light-mode-only)
3740

3841
### **Need help?**
3942

40-
If you require assistance, our support team is here to help. Simply click on the help icon within the CodeRabbit user interface. For more detailed information, please refer to the "Support" section. Additionally, consider joining the CodeRabbit Discord community to connect with other users and access a wealth of knowledge about using CodeRabbit effectively.
43+
If you require assistance, our support team is here to help. Simply click on the help icon within the CodeRabbit user interface. For more detailed information, please refer to the "Support" section. Additionally, consider joining the CodeRabbit Discord community to connect with other users and access a wealth of knowledge about using CodeRabbit effectively.

‎docs/get-started/images/add1.png

-45.7 KB
Binary file not shown.

‎docs/get-started/images/add4.png

-48.9 KB
Binary file not shown.

‎docs/get-started/images/analytic2.png

-242 KB
Binary file not shown.

‎docs/get-started/images/analytic3.png

-15.8 KB
Binary file not shown.

‎docs/get-started/images/cr_add_repo_dark.png

271 KB
Loading

‎docs/get-started/images/cr_add_repo_gitlab_dark.png

246 KB
Loading

‎docs/get-started/images/cr_add_repo_gitlab_light.png

265 KB
Loading

‎docs/get-started/images/cr_add_repo_light.png

282 KB
Loading

‎docs/get-started/images/cr_dash_dark.png

267 KB
Loading

‎docs/get-started/images/cr_dash_light.png

271 KB
Loading

‎docs/get-started/images/cr_history_dark.png

61.6 KB
Loading

‎docs/get-started/images/cr_history_light.png

71.9 KB
Loading

‎docs/get-started/images/cr_login.png

72.4 KB
Loading

‎docs/get-started/images/cr_login2.png

187 KB
Loading

‎docs/get-started/images/cr_login_dark.png

191 KB
Loading

‎docs/get-started/images/signup.png

-43.9 KB
Binary file not shown.

‎docs/get-started/signup.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ Signing up for CodeRabbit is quick and easy, allowing you to get started in just
2828

2929
### **Step 1: Getting Started**
3030

31-
**Login with GitHub or GitLab**: Log in with your GitHub or GitLab account at https://coderabbit.ai/login
31+
**Login with GitHub or GitLab**: Log in with your GitHub or GitLab account at [https://coderabbit.ai/login](https://coderabbit.ai/login)
3232

33-
![Untitled](./images/signup.png)
33+
![Login](./images/cr_login2.png#gh-light-mode-only)
34+
![Login](./images/cr_login_dark.png#gh-dark-mode-only)
3435

3536
### **Step 2: Select Organization**
3637

@@ -44,9 +45,11 @@ After selecting the organization, you will be directed to a GitHub repositories
4445

4546
![Untitled](./images/add3.png)
4647

47-
After you have installed the CodeRabbit app, the reviews will start automatically with the new pull requests or incremental commits to existing pull requests. To trigger reviews on existing pull requests, post @coderabbitai review as a comment on the pull request.
48+
After you have installed the CodeRabbit app, the reviews will start automatically with the new pull requests or incremental commits to existing pull requests. To trigger reviews on existing pull requests, post "@coderabbitai review" as a comment on the pull request.
4849

49-
Note that the automatic code review behavior can be changed to "On-Demand". To make this change, go to the repository settings in the UI or modify the appropriate setting in the YAML file to disable reviews.
50+
:::tip
51+
The automatic code review behavior can be changed to "On-Demand". To make this change, go to the repository settings in the UI or modify the appropriate setting in the YAML file to disable reviews.
52+
:::
5053

5154
### **Need help?**
5255

‎docs/guides/coderabbit-commands.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Efficiently manage your PR reviews with our intuitive commands. Use
44
sidebar_label: CodeRabbit Commands
55
image: "/preview_meta.jpg"
66
---
7+
78
<head>
89
<meta charSet="utf-8" />
910
<meta name="title" content="CodeRabbit Commands" />
@@ -25,26 +26,28 @@ Manage your PR reviews with the following commands:
2526

2627
By default, CodeRabbit automatically reviews all pull requests. Additionally, for each pull request, it will review all incremental commits. However, this behavior can be overridden using the following commands:
2728

28-
- **Pause Reviews**:
29+
- **Pause Reviews**:
2930
- Use `@coderabbitai pause` in a PR comment to halt ongoing reviews.
30-
31-
- **Resume Reviews**:
31+
- **Resume Reviews**:
3232
- Enter `@coderabbitai resume` in a PR comment to continue paused reviews.
33-
34-
- **On-Demand Reviews**:
33+
- **On-Demand Reviews**:
3534
- Disable automatic reviews for your repository to switch to on-demand reviews.
36-
- Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review.
37-
38-
- **Skip Specific PR**:
35+
- Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review.
36+
- **Skip Specific PR**:
37+
3938
- To exclude a specific PR from review, include `@coderabbitai ignore` in the PR description.
4039

4140
- **Resolve Command**:
41+
4242
- Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once.
4343

4444
- **Help Command**:
4545
- You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands.
4646

47-
**Note:** Ensure you input these commands as PR comments. For direct bot interactions, use review comments on code diffs or files.
47+
:::note
48+
Ensure you input these commands as PR comments. For direct bot interactions, enter your input in the review comments of a code diff or file.
49+
:::
4850

4951
### Feedback
52+
5053
If you have suggestions for additional commands or improvements, we would love to hear from you! Please submit your feedback to our support team.

‎docs/guides/customize-coderabbit.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ specific requirements. Customizations can be made using one of the below options
3232

3333
Customization defined in the YAML file overrides the settings in the UI.
3434

35-
#### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit)
35+
### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit)
3636

3737
You can add a `.coderabbit.yaml` configuration file to your repositories. Below
3838
is a sample YAML file that can be used as a starting point and change as needed:
@@ -73,10 +73,12 @@ chat:
7373
auto_reply: true
7474
```
7575
76-
**Note**: `.coderabbit.yaml` file should be placed at the root directory of the
76+
:::note
77+
`.coderabbit.yaml` file should be placed at the root directory of the
7778
repository.
79+
:::
7880

79-
Yaml settings:
81+
YAML settings:
8082

8183
1. **language**: Set the language for reviews using the ISO language code. For
8284
example, `"fr"` stands for French (default:`en`).
@@ -136,7 +138,7 @@ settings:
136138
path_based_instructions:
137139
- path: "**/*.js"
138140
instructions:
139-
"Review the javascript code against the google javascript style guide
141+
"Review the JavaScript code against the Google JavaScript style guide
140142
and point out any mismatches"
141143
- path: "tests/**/*"
142144
instructions:
@@ -193,18 +195,20 @@ Refer:
193195

194196
</details>
195197

196-
#### 2. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard)
198+
### 2. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard)
197199

198200
Reviews can also be customized through the UI under repository settings:
199201

202+
---
203+
200204
### Review Customization[](https://coderabbit.ai/docs/get-started#review-customization)
201205

202206
[](../get-started/images/tailor2.png)
203207

204-
**Path based instructions :** Provide additional review guidelines based on the
208+
**Path-based instructions :** Provide additional review guidelines based on the
205209
file paths using glob patterns.
206210

207-
For further guidance please refer this
211+
For further guidance, please refer this
208212
section [Prompt Customization](/guides/prompt-customization)
209213

210214
**Language Selection:** Select the natural language in which you want the review
@@ -214,6 +218,8 @@ language is English.
214218
**Disable High Level Summary:** This allows disabling high level summary added
215219
with the pull request description.
216220

221+
---
222+
217223
### Review Filters [](https://coderabbit.ai/docs/get-started#review-filters)
218224

219225
[](../get-started/images/tailor3.png)

‎docs/guides/prompt-customization.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ sidebar_label: Prompt Customization
44
description: Accelerate Code Reviews with AI
55
image: "/preview_meta.jpg"
66
---
7+
78
<head>
89
<meta charSet="utf-8" />
910
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
@@ -21,29 +22,29 @@ image: "/preview_meta.jpg"
2122
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
2223
</head>
2324

24-
### Path based instructions[](https://coderabbit.ai/docs/prompt-customization#path-based-instructions)
25-
26-
This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review.
25+
### Path-based instructions[](https://coderabbit.ai/docs/prompt-customization#path-based-instructions)
2726

28-
### Overview[](https://coderabbit.ai/docs/prompt-customization#overview)
27+
This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review.
2928

3029
Adding file path prompts allows developers to specify custom instructions for different parts of the codebase. For example, you may want to enforce style guide by file types or directories.
3130

3231
### Sample Usage[](https://coderabbit.ai/docs/prompt-customization#sample-usage)
3332

3433
**path:** `**/*.js`
3534

36-
**instructions:** Review the javascript code against the google javascript style guide and point out any mismatches
35+
**instructions:** Review the JavaScript code against the Google JavaScript style guide and point out any mismatches
3736

3837
**path:** `tests/**.*`
3938

40-
**instructions:** Review the following unit test code written using the Mocha test library.
39+
**instructions:** Review the following unit test code written using the Mocha test library.
4140
Ensure that:
4241
The code adheres to best practices associated with Mocha.
4342
Descriptive test names are used to clearly convey the intent of each test.
4443

45-
### Notes[](https://coderabbit.ai/docs/prompt-customization#best-practices)
44+
:::note
4645

4746
- Paths accept glob patterns.
4847
- Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something.
49-
- Test the review feedback on pull requests and tailor as necessary.
48+
- Test the review feedback on pull requests and tailor as necessary.
49+
50+
:::

‎docs/integrations/self-hosted-gitlab.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To initiate the integration, we require specific information. This is essential
2828

2929
### **Step 1: Getting Started**
3030

31-
**Visit CodeRabbit:** Land on to our login page https://coderabbit.ai/login and select Self-Hosted GitLab
31+
**Visit CodeRabbit:** Land on to our [Login](https://coderabbit.ai/login) page and select Self-Hosted GitLab
3232

3333
![login-page](./images/login-page.png)
3434

@@ -46,15 +46,15 @@ If this is the first time you are signing up with your instance, we need an admi
4646

4747
GitLab offers an option to generate a personal access token for adding a new user and setting up the application in the self-managed instance. To generate the token, please follow the process outlined below:
4848

49-
1. Login to your self-hosted instance. Ensure sure you have admin rights.
50-
2. On the left sidebar, select your avatar.
51-
3. Select Edit profile.
52-
4. On the left sidebar, select Access Tokens.
53-
5. Select Add new token.
54-
6. Enter a name and expiry date for the token. We need this for the initial setup, so the minimum expiry time is sufficient.
55-
7. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
56-
8. Make sure, you select the scope: `api`
57-
9. Select Create personal access token.
49+
1. Login to your self-hosted instance. Ensure sure you have admin rights.
50+
2. On the left sidebar, select your avatar.
51+
3. Select Edit profile.
52+
4. On the left sidebar, select Access Tokens.
53+
5. Select Add new token.
54+
6. Enter a name and expiry date for the token. We need this for the initial setup, so the minimum expiry time is sufficient.
55+
7. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
56+
8. Make sure, you select the scope: `api`
57+
9. Select Create personal access token.
5858
10. Please note down this token as this will be visible one time only
5959

6060
![Untitled](./images/admin-access-token.png)
@@ -64,10 +64,10 @@ GitLab offers an option to generate a personal access token for adding a new use
6464
- Submit the access token.
6565
- We will handle the setup process for you.
6666
- On subsequent visits, your setup will be automatically detected, allowing for direct login.
67-
![Untitled](./images/self-hosted-page.png)
67+
![Untitled](./images/self-hosted-page.png)
6868

6969
### **Step 5: Whitelist CodeRabbit IP address**
7070

71-
Use this CodeRabbit IP if your instance requires IP whitelisting `35.222.179.152/32`
71+
Use this CodeRabbit IP if your instance requires IP whitelisting `35.222.179.152/32`
7272

73-
- Furthermore, please refer to our Get Started Guide to make the most of CodeRabbit [here](../get-started/add-repo.md).
73+
- Furthermore, please refer to our Get Started Guide to make the most of CodeRabbit [here](../get-started/add-repo.md).

0 commit comments

Comments
 (0)