Skip to content

Commit e36c04b

Browse files
harjotgilltyaga001
authored andcommitted
restructure existing docs
1 parent 174f510 commit e36c04b

File tree

9 files changed

+340
-313
lines changed

9 files changed

+340
-313
lines changed

docs/faq/faq.md

+44-33
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,70 @@
11
---
22
title: FAQs
33
sidebar_label: FAQs
4-
description: Accelerate Code Reviews with AI
5-
image: "/preview_meta.jpg"
4+
description: Frequently asked questions about CodeRabbit.
65
---
76

8-
<head>
9-
<meta charSet="utf-8" />
10-
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
11-
<meta name="description" content="Accelerate Code Reviews with AI" />
12-
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" />
18-
19-
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
20-
<meta name="twitter:card" content="summary_large_image" />
21-
<meta name="twitter:title" content="CodeRabbit: AI-powered Code Reviews" />
22-
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
23-
</head>
24-
257
#### **1. How accurate is CodeRabbit's review?**
268

27-
Early adoption results for CodeRabbit have been highly promising, demonstrating significant accuracy in code reviews. However, it's crucial to understand that AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our technology is continuously learning and improving, aiming for the highest possible accuracy in reviews.
9+
Early adoption results for CodeRabbit have been highly promising, demonstrating
10+
significant accuracy in code reviews. However, it's crucial to understand that
11+
AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our
12+
technology is continuously learning and improving, aiming for the highest
13+
possible accuracy in reviews.
2814

2915
#### **2. Which programming languages does CodeRabbit support?**
3016

31-
CodeRabbit is designed to work with all programming languages. However, the proficiency of our AI models might vary between languages, which could slightly affect the accuracy of the review.
17+
CodeRabbit is designed to work with all programming languages. However, the
18+
proficiency of our AI models might vary between languages, which could slightly
19+
affect the accuracy of the review.
3220

3321
#### **3. Does CodeRabbit store my code or use it for training language models?**
3422

35-
We train our system using open source projects. For private repositories, neither CodeRabbit nor OpenAI LLMs use your code for training purposes.
23+
We train our system using open source projects. For private repositories,
24+
neither CodeRabbit nor OpenAI LLMs use your code for training purposes.
3625

3726
#### **4. What Large Language Models does CodeRabbit use?**
3827

39-
CodeRabbit currently utilizes Open AI's GPT 4 and GPT 3.5. We're researching and testing upcoming LLMs to ensure we're offering the most precise reviews possible.
28+
CodeRabbit currently utilizes Open AI's GPT 4 and GPT 3.5. We're researching and
29+
testing upcoming LLMs to ensure we're offering the most precise reviews
30+
possible.
4031

4132
#### **5. Can I customize CodeRabbit?**
4233

43-
Reviews are customizable. For information, check out our [Get Started page](/get-started/signup).
34+
Reviews are customizable. For information, check out our
35+
[Get Started page](/get-started/signup).
4436

4537
#### **6. Can I choose a language other than English for the reviews?**
4638

47-
CodeRabbit supports most widely-used languages. You can configure this in the repository settings.
39+
CodeRabbit supports most widely used languages. You can configure this in the
40+
repository settings.
4841

4942
#### **7. What access does CodeRabbit need to my repositories?**
5043

51-
CodeRabbit requests minimal access to perform code reviews and post comments on Pull Requests. On GitHub, it requires read access to metadata, code, discussions, issues, and read/write access to the pull requests. On GitLab, it requires read access to the repository, and the CodeRabbit Bot user requires a developer role.
44+
CodeRabbit requests minimal access to perform code reviews and post comments on
45+
Pull Requests. On GitHub, it requires read access to metadata, code,
46+
discussions, issues, and read/write access to the pull requests. On GitLab, it
47+
requires read access to the repository, and the CodeRabbit Bot user requires a
48+
developer role.
5249

5350
#### **8. How can I add or remove users for my subscription?**
5451

55-
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add or remove users as needed.
52+
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
53+
or remove users as needed.
5654

5755
#### **9. How can I interact with the CodeRabbit bot?**
5856

59-
To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are team members collaborating on pull requests, the bot stays silent by default but can be engaged by tagging **@Coderabbitai**. This feature allows you to provide context, generate test cases, or ask for specific code suggestions, all within the context of your code lines or entire files.
57+
To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are
58+
team members collaborating on pull requests, the bot stays silent by default but
59+
can be engaged by tagging **@Coderabbitai**. This feature allows you to provide
60+
context, generate test cases, or ask for specific code suggestions, all within
61+
the context of your code lines or entire files.
6062

6163
#### **10. Can individual developers use CodeRabbit?**
6264

63-
Absolutely! Whether you're an individual developer or part of an organization, CodeRabbit can be your coding assistant, providing you with invaluable suggestions.
65+
Absolutely! Whether you're an individual developer or part of an organization,
66+
CodeRabbit can be your coding assistant, providing you with invaluable
67+
suggestions.
6468

6569
#### **11. Which branches are the pull requests reviewed on?**
6670

@@ -78,14 +82,21 @@ There are hourly rate limits for each developer per repository:
7882
- Number of reviews : 3 back to back reviews followed by 4 reviews/hour
7983
- Number of conversations: 25 back to back messages followed by 50 messages/hr
8084

81-
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.
85+
In-trial and open-source plans have lower rate limits than the paid plan. In all
86+
cases, we re-allow further reviews/conversations after a brief timeout.
8287

8388
#### **14. I can't add CodeRabbit to my GitLab Repositories?**
8489

85-
If there are any access restrictions by domain, then you will need to add `coderabbit.ai` as an allowed domain.
90+
If there are any access restrictions by domain, then you will need to add
91+
`coderabbit.ai` as an allowed domain.
8692

8793
:::note
88-
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.
94+
95+
We are continually innovating and enhancing our application with new
96+
capabilities. Stay tuned and follow us for updates as new exciting features are
97+
built. We're committed to making your experience with CodeRabbit even better.
98+
8999
:::
90100

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

docs/get-started/add-repo.md

+16-24
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,29 @@
11
---
22
title: Add Repositories
33
sidebar_label: Add Repositories
4-
description: Accelerate Code Reviews with AI
5-
image: "/preview_meta.jpg"
4+
description: Learn how to add CodeRabbit to your GitHub or GitLab repositories.
65
---
76

8-
<head>
9-
<meta charSet="utf-8" />
10-
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
11-
<meta name="description" content="Accelerate Code Reviews with AI" />
12-
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" />
18-
19-
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
20-
<meta name="twitter:card" content="summary_large_image" />
21-
<meta name="twitter:title" content="CodeRabbit: AI-powered Code Reviews" />
22-
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
23-
</head>
24-
257
Learn how to add CodeRabbit to your GitHub or GitLab repositories.
268

27-
To add additional repositories after the sign-up, go to the repositories page within the CodeRabbit UI.
9+
To add additional repositories after the sign-up, go to the repositories page
10+
within the CodeRabbit UI.
2811

29-
Click on the "**Add repositories**" button. Upon clicking, you'll be redirected to GitHub.
12+
Click on the "**Add repositories**" button. Upon clicking, you'll be redirected
13+
to GitHub.
3014

3115
![AddRepo](./images/cr_add_repo_light.png#gh-light-mode-only)
3216
![AddRepo](./images/cr_add_repo_dark.png#gh-dark-mode-only)
3317

34-
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.
18+
Upon successful installation, you will be automatically redirected back to the
19+
CodeRabbit UI. Here, you can view the list of repositories that CodeRabbit now
20+
has access to.
3521

3622
:::note
3723

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.
24+
For **GitLab**, the flow is slightly different. All the repositories display by
25+
default, and you can toggle and enable the ones where the CodeRabbit app should
26+
be installed.
3927

4028
![AddRepo](./images/cr_add_repo_gitlab_light.png#gh-light-mode-only)
4129
![AddRepo](./images/cr_add_repo_gitlab_dark.png#gh-dark-mode-only)
@@ -44,4 +32,8 @@ For **GitLab** the flow is slightly different. All the repositories display by d
4432

4533
### **Need help?**
4634

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.
35+
If you require assistance, our support team is here to help. Simply click on the
36+
help icon within the CodeRabbit user interface. For more detailed information,
37+
please refer to the "Support" section. Additionally, consider joining the
38+
CodeRabbit **Discord** community to connect with other users and access a wealth
39+
of knowledge about using CodeRabbit effectively.

docs/get-started/analytics.md

+20-28
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,35 @@
11
---
22
title: CodeRabbit Dashboard
33
sidebar_label: CodeRabbit Dashboard
4+
description:
5+
CodeRabbit Dashboard displays organization's pull request activity and value
6+
provided by CodeRabbit reviews.
47
slug: /dashboard
5-
description: Accelerate Code Reviews with AI
6-
image: "/preview_meta.jpg"
78
---
89

9-
<head>
10-
<meta charSet="utf-8" />
11-
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
12-
<meta name="description" content="Accelerate Code Reviews with AI" />
10+
CodeRabbit Dashboard displays organization's pull request activity and value
11+
provided by CodeRabbit reviews. This includes the number of pull requests
12+
reviewed, actionable items, optional comments and more.
1313

14-
<meta property="og:type" content="website" />
15-
<meta property="og:url" content="https://coderabbit.ai/" />
16-
<meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
17-
<meta property="og:description" content="Accelerate Code Reviews with AI" />
18-
<meta property="og:image" content="/preview_meta.jpg" />
14+
The dashboard displays the following information:
1915

20-
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
21-
<meta name="twitter:card" content="summary_large_image" />
22-
<meta name="twitter:title" content="CodeRabbit: AI-powered Code Reviews" />
23-
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
24-
</head>
16+
- **Pull Requests Overview:** View the number of pull requests reviewed by
17+
CodeRabbit per week, month, and year.
18+
- **CodeRabbit's Activity:** Understand the metrics related to the number of
19+
reviews conducted by CodeRabbit, actionable items, and optional suggestions.
2520

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.
27-
28-
Dashboard displays the following information:
29-
30-
- **Pull Requests Overview:** View the number of pull requests reviewed by CodeRabbit per week, month, and year.
31-
- **CodeRabbit's Activity:** Understand the metrics related to the number of reviews conducted by CodeRabbit, actionable items, and optional suggestions.
32-
33-
![Untitled](./images/cr_dash_dark.png#gh-dark-mode-only)
34-
![Untitled](./images/cr_dash_light.png#gh-light-mode-only)
21+
![Dashboard](./images/cr_dash_dark.png#gh-dark-mode-only)
22+
![Dashboard](./images/cr_dash_light.png#gh-light-mode-only)
3523

3624
Access the list of recent pull requests reviewed.
3725

38-
![Untitled](./images/cr_history_dark.png#gh-dark-mode-only)
39-
![Untitled](./images/cr_history_light.png#gh-light-mode-only)
26+
![History](./images/cr_history_dark.png#gh-dark-mode-only)
27+
![History](./images/cr_history_light.png#gh-light-mode-only)
4028

4129
### **Need help?**
4230

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.
31+
If you require assistance, our support team is here to help. Simply click on the
32+
help icon within the CodeRabbit user interface. For more detailed information,
33+
please refer to the "Support" section. Additionally, consider joining the
34+
CodeRabbit Discord community to connect with other users and access a wealth of
35+
knowledge about using CodeRabbit effectively.

docs/get-started/signup.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
11
---
22
title: Sign Up
33
sidebar_label: Sign Up
4-
description: Accelerate Code Reviews with AI
5-
image: "/preview_meta.jpg"
4+
description:
5+
Learn how to sign up for CodeRabbit and get started with your first code
6+
review.
67
---
78

8-
<head>
9-
<meta charSet="utf-8" />
10-
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
11-
<meta name="description" content="Accelerate Code Reviews with AI" />
12-
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" />
18-
19-
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
20-
<meta name="twitter:card" content="summary_large_image" />
21-
<meta name="twitter:title" content="CodeRabbit: AI-powered Code Reviews" />
22-
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
23-
</head>
24-
259
### **Sign Up for CodeRabbit**
2610

27-
Signing up for CodeRabbit is quick and easy, allowing you to get started in just a few seconds. Whether you're an individual developer or part of a team, you can start for free and upgrade to a paid plan after a no-commitment trial. For more information about CodeRabbit's subscription plan options, please refer to the pricing page.
11+
Signing up for CodeRabbit is quick and easy, allowing you to get started in just
12+
a few seconds. Whether you're an individual developer or part of a team, you can
13+
start for free and upgrade to a paid plan after a no-commitment trial. For more
14+
information about CodeRabbit's subscription plan options, please refer to the
15+
pricing page.
2816

2917
### **Step 1: Getting Started**
3018

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

3322
![Login](./images/cr_login2.png#gh-light-mode-only)
3423
![Login](./images/cr_login_dark.png#gh-dark-mode-only)
3524

3625
### **Step 2: Select Organization**
3726

38-
On the GitHub page, you will be prompted to choose the organization where you want to install the CodeRabbit app. Select the organization to proceed.
27+
On the GitHub page, you will be prompted to choose the organization where you
28+
want to install the CodeRabbit app. Select the organization to proceed.
3929

4030
![Untitled](./images/add2.png)
4131

4232
### **Step 3: Authorize CodeRabbit**
4333

44-
After selecting the organization, you will be directed to a GitHub repositories page where you will install and authorize the CodeRabbit GitHub app. You can choose to grant access to all your organization's repositories or select specific repositories.
34+
After selecting the organization, you will be directed to a GitHub repositories
35+
page where you will install and authorize the CodeRabbit GitHub app. You can
36+
choose to grant access to all your organization's repositories or select
37+
specific repositories.
4538

4639
![Untitled](./images/add3.png)
4740

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.
41+
After you have installed the CodeRabbit app, the reviews will start
42+
automatically with the new pull requests or incremental commits to existing pull
43+
requests. To trigger reviews on existing pull requests, post "@coderabbitai
44+
review" as a comment on the pull request.
4945

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-
:::
46+
:::tip The automatic code review behavior can be changed to "On-Demand". To make
47+
this change, go to the repository settings in the UI or modify the appropriate
48+
setting in the YAML file to disable reviews. :::
5349

5450
### **Need help?**
5551

56-
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.
52+
If you require assistance, our support team is here to help. Simply click on the
53+
help icon within the CodeRabbit user interface. For more detailed information,
54+
please refer to the "Support" section. Additionally, consider joining the
55+
CodeRabbit Discord community to connect with other users and access a wealth of
56+
knowledge about using CodeRabbit effectively.

0 commit comments

Comments
 (0)