Skip to content

Commit 2ba4987

Browse files
karan925harjotgill
authored andcommitted
Fix images for light and dark mode. Made improvements to docs (#22)
1 parent 26799b5 commit 2ba4987

38 files changed

+196
-156
lines changed

docs/about/images/CodeRabbitFlow.png

-150 KB
Loading
296 KB
Loading
301 KB
Loading
298 KB
Loading
303 KB
Loading
325 KB
Loading
151 KB
Loading
262 KB
Loading
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/about/pricing.md

+49-41
Original file line numberDiff line numberDiff line change
@@ -24,70 +24,78 @@ image: "/preview_meta.jpg"
2424

2525
This section covers the plans, pricing, and subscription management of CodeRabbit.
2626

27-
### **Understanding Your Options**
27+
## **Understanding Your Options**
2828

29-
- **Transparent Pricing**: CodeRabbit offers a per-seat pricing model that scales with your team size, ensuring you pay for what you need.
30-
- **7-Day Free Trial**: All plans start with a generous 7-day free trial for CodeRabbit Pro for the entire organization, ensuring a commitment-free experience
31-
- **No Credit Card Required**: You won't need a credit card to start your free trial.
32-
- **CodeRabbit Seats**
33-
Every developer who submits a pull request is counted as a separate seat. Seats can be purchased for all or for a limited number of developers.
29+
- **Transparent Pricing**: CodeRabbit offers a per-seat pricing model that scales with your team size, ensuring you pay for what you need.
30+
- **7-Day Free Trial**: All plans start with a generous 7-day free trial for CodeRabbit Pro for the entire organization, ensuring a commitment-free experience
31+
- **No Credit Card Required**: You won't need a credit card to start your free trial.
32+
- **CodeRabbit Seats**
33+
Every developer who submits a pull request is counted as a separate seat. Seats can be purchased for all or for a limited number of developers.
3434

35-
### 1. Pro Plan
35+
---
36+
37+
## **Pro Plan**
3638

37-
### Features:
39+
### Features
3840

39-
- This plan begins with a 7-day free trial, with no credit card required.
40-
- Summarization of pull requests.
41-
- Includes line-by-line reviews of all changes in the Pull Request
42-
- Ability to have conversations with CodeRabbit bot.
43-
- Reviews on unlimited public and private repositories within the organization.
41+
- This plan begins with a 7-day free trial, with no credit card required.
42+
- Summarization of pull requests.
43+
- Includes line-by-line reviews of all changes in the Pull Request
44+
- Ability to have conversations with CodeRabbit bot.
45+
- Reviews on unlimited public and private repositories within the organization.
4446

45-
### Pricing:
47+
### Pricing
4648

47-
- Monthly: $15 per month.
48-
- Annual: $12 per month billed annually, with a 20% discount.
49+
- Monthly: $15 per month.
50+
- Annual: $12 per month billed annually, with a 20% discount.
4951

50-
### Billing:
52+
### Billing
5153

52-
- Billed per participating developer.
54+
- Billed per participating developer.
5355

54-
### Usage Limits:
56+
### Usage Limits
5557

5658
These are the hourly usage limits for each developer per repository:
5759

58-
- Number of files reviewed per hour: 100 Files
59-
- Number of reviews per hour (includes incremental reviews): 9
60-
- Number of conversations per hour: 50
60+
- Number of files reviewed per hour: 100 Files
61+
- Number of reviews per hour (includes incremental reviews): 9
62+
- Number of conversations per hour: 50
63+
64+
---
65+
66+
## **Free Plan**
6167

62-
### 2. Free Plan
68+
### Features
6369

64-
### Features:
70+
- Starts with a 7-day free trial of the Pro plan.
71+
- unlimited access on both public and private repositories.
72+
- Summarization pull requests on private repositories.
73+
- Reviews pull requests on public repositories.
6574

66-
- Starts with a 7-day free trial of the Pro plan.
67-
- unlimited access on both public and private repositories.
68-
- Summarization pull requests on private repositories.
69-
- Reviews pull requests on public repositories.
75+
### Pricing
7076

71-
### Pricing:
77+
- $0 per month.
7278

73-
- $0 per month.
79+
### Billing
7480

75-
### Billing:
81+
- Free forever, no credit card required.
7682

77-
- Free forever, no credit card required.
83+
---
7884

79-
### **Subscription Management**
85+
## **Subscription Management**
8086

81-
### 1. Pro Plan
87+
### Pro Plan
8288

83-
- GitHub/GitLab organization owners can purchase or make changes to the subscription.
84-
- You can choose to manually purchase seats and assign them to developers, or have them assigned automatically as developers create pull requests.
85-
- During the trial period, seat assignment is automatic, but the number of seats can be adjusted when purchasing the subscription.
89+
- GitHub/GitLab organization owners can purchase or make changes to the subscription.
90+
- You can choose to manually purchase seats and assign them to developers, or have them assigned automatically as developers create pull requests.
91+
- During the trial period, seat assignment is automatic, but the number of seats can be adjusted when purchasing the subscription.
8692

87-
![Untitled](./images/pricing.png)
93+
![Untitled](./images/cr_seat_manage_dark.png#gh-dark-mode-only)
94+
![Untitled](./images/cr_seat_manage_light.png#gh-light-mode-only)
8895

89-
### 2. Free Plan
96+
### Free Plan
9097

91-
- Seats are assigned to new developers immediately
98+
- Seats are assigned to new developers immediately
9299

93-
![Untitled](./images/pricing2.png)
100+
![Untitled](./images/cr_seat_free_dark.png#gh-dark-mode-only)
101+
![Untitled](./images/cr_seat_free_light.png#gh-light-mode-only)

docs/about/support.md

+22-18
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ image: "/preview_meta.jpg"
1010
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
1111
<meta name="description" content="Accelerate Code Reviews with AI" />
1212

13-
<meta property="og:type" content="website" />
14-
<meta property="og:url" content="https://coderabbit.ai/" />
15-
<meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
16-
<meta property="og:description" content="Accelerate Code Reviews with AI" />
17-
<meta property="og:image" content="/preview_meta.jpg" />
13+
{" "}
14+
15+
<meta property="og:type" content="website" />
16+
<meta property="og:url" content="https://coderabbit.ai/" />
17+
<meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
18+
<meta property="og:description" content="Accelerate Code Reviews with AI" />
19+
<meta property="og:image" content="/preview_meta.jpg" />
1820

1921
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
2022
<meta name="twitter:card" content="summary_large_image" />
@@ -28,49 +30,51 @@ Welcome to CodeRabbit's Support! Please refer this section if you encounter any
2830

2931
These are the most common questions our support team receives, and you might find an answer here
3032

31-
### 1. Can I switch between different organizations on CodeRabbit?
33+
### Can I switch between different organizations on CodeRabbit?
3234

3335
Yes, you can switch between different organizations on CodeRabbit. To do so, click on the organization name in the top right corner of the CodeRabbit UI.
3436

35-
![Switch Organizations](./images/help3.png)
37+
<div align="center">![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)</div>
38+
<div align="center">![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)</div>
3639

37-
### 2. Can CodeRabbit subscription be used across multiple organizations?
40+
### Can CodeRabbit subscription be used across multiple organizations?
3841

3942
Subscription seat are tied to the specific GitHub/GitLab organization under which they are purchased and cannot be used under another organization.
4043

41-
### 3. Can CodeRabbit review my existing PRs after integrating it?
44+
### Can CodeRabbit review my existing PRs after integrating it?
4245

4346
CodeRabbit would by default only review new PRs or existing PRs which have a new commits after the app is installed.
4447
You can however use @coderabbitai review command on the PR to trigger a review of existing PRs.
4548

46-
### 4. Who can add the repositories on CodeRabbit?
49+
### Who can add the repositories on CodeRabbit?
4750

4851
You need to be GitHub/GitLab admin to add the repositories.
4952

50-
### 5. Do I need own OpenAI key with CodeRabbit Pro?
53+
### Do I need own OpenAI key with CodeRabbit Pro?
5154

5255
OpenAI cost is part of the subscription.There is no additional cost for OpenAI.
5356

54-
### 6. What is the difference between CodeRabbit OSS ai-pr-reviewer and CodeRabbit Pro ?
57+
### What is the difference between CodeRabbit OSS ai-pr-reviewer and CodeRabbit Pro ?
5558

5659
ai-pr-reviewer is our Open Source Software (OSS) for pull request reviews. With CodeRabbit OSS, you need your own OpenAI key, and you will incur OpenAI costs.
5760
On the other hand, with a CodeRabbit Pro subscription, the OpenAI cost is included. Additionally, CodeRabbit Pro offers advanced prompts and superior noise reduction features, which are not present in CodeRabbit OSS.
5861

59-
### 7. Can I use both CodeRabbit OSS and CodeRabbit Pro together ?
62+
### Can I use both CodeRabbit OSS and CodeRabbit Pro together ?
6063

6164
You can, but this will result in duplicate reviews. We suggest you use only one of the two.
6265

63-
### Explore More
64-
65-
To see more common issues faced by CodeRabbit users, visit our FAQ section for detailed answers and solutions to frequently encountered problems.
66-
6766
### **Opening a Support Ticket**
6867

6968
To get assistance from our support team, open a ticket using the help icon on the CodeRabbit UI:
7069

7170
Complete the support ticket by providing your name, email, a description of your issue, and attaching any necessary files. If you are reporting a bug , please provide the GitHub or GitLab organization name.
7271

73-
![Open a Ticket](./images/help2.png)
72+
![Open a Ticket](./images/cr_support_help_light.png#gh-light-mode-only)
73+
![Open a Ticket](./images/cr_support_help_dark.png#gh-dark-mode-only)
74+
75+
:::tip
76+
To see more common issues faced by CodeRabbit users, visit our FAQ section for detailed answers and solutions to frequently encountered problems.
77+
:::
7478

7579
### **Community Collaboration**
7680

docs/faq/faq.md

+6-5
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

+10-4
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

+8-5
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.
271 KB
Loading
Loading
Loading
282 KB
Loading
267 KB
Loading
271 KB
Loading
61.6 KB
Loading
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
191 KB
Loading

docs/get-started/images/signup.png

-43.9 KB
Binary file not shown.

docs/get-started/signup.md

+7-4
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

+12-9
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.

0 commit comments

Comments
 (0)