diff --git a/docs/about/images/CodeRabbitFlow.png b/docs/about/images/CodeRabbitFlow.png
index 87672c95..81cce737 100644
Binary files a/docs/about/images/CodeRabbitFlow.png and b/docs/about/images/CodeRabbitFlow.png differ
diff --git a/docs/about/images/cr_seat_free_dark.png b/docs/about/images/cr_seat_free_dark.png
new file mode 100644
index 00000000..84398cd2
Binary files /dev/null and b/docs/about/images/cr_seat_free_dark.png differ
diff --git a/docs/about/images/cr_seat_free_light.png b/docs/about/images/cr_seat_free_light.png
new file mode 100644
index 00000000..1dbcc00b
Binary files /dev/null and b/docs/about/images/cr_seat_free_light.png differ
diff --git a/docs/about/images/cr_seat_manage_dark.png b/docs/about/images/cr_seat_manage_dark.png
new file mode 100644
index 00000000..b7506378
Binary files /dev/null and b/docs/about/images/cr_seat_manage_dark.png differ
diff --git a/docs/about/images/cr_seat_manage_light.png b/docs/about/images/cr_seat_manage_light.png
new file mode 100644
index 00000000..ca34b92c
Binary files /dev/null and b/docs/about/images/cr_seat_manage_light.png differ
diff --git a/docs/about/images/cr_support_help_dark.png b/docs/about/images/cr_support_help_dark.png
new file mode 100644
index 00000000..0534d96e
Binary files /dev/null and b/docs/about/images/cr_support_help_dark.png differ
diff --git a/docs/about/images/cr_support_help_light.png b/docs/about/images/cr_support_help_light.png
new file mode 100644
index 00000000..c3071afc
Binary files /dev/null and b/docs/about/images/cr_support_help_light.png differ
diff --git a/docs/about/images/cr_support_orgs_dark.png b/docs/about/images/cr_support_orgs_dark.png
new file mode 100644
index 00000000..3519964c
Binary files /dev/null and b/docs/about/images/cr_support_orgs_dark.png differ
diff --git a/docs/about/images/cr_support_orgs_light.png b/docs/about/images/cr_support_orgs_light.png
new file mode 100644
index 00000000..c84eae8f
Binary files /dev/null and b/docs/about/images/cr_support_orgs_light.png differ
diff --git a/docs/about/images/pricing.png b/docs/about/images/pricing.png
deleted file mode 100644
index 6d7b4dc7..00000000
Binary files a/docs/about/images/pricing.png and /dev/null differ
diff --git a/docs/about/images/pricing2.png b/docs/about/images/pricing2.png
deleted file mode 100644
index d592fda7..00000000
Binary files a/docs/about/images/pricing2.png and /dev/null differ
diff --git a/docs/about/pricing.md b/docs/about/pricing.md
index f10f3f89..6efa4439 100644
--- a/docs/about/pricing.md
+++ b/docs/about/pricing.md
@@ -24,70 +24,78 @@ image: "/preview_meta.jpg"
This section covers the plans, pricing, and subscription management of CodeRabbit.
-### **Understanding Your Options**
+## **Understanding Your Options**
-- **Transparent Pricing**: CodeRabbit offers a per-seat pricing model that scales with your team size, ensuring you pay for what you need.
-- **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
-- **No Credit Card Required**: You won't need a credit card to start your free trial.
-- **CodeRabbit Seats**
- 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.
+- **Transparent Pricing**: CodeRabbit offers a per-seat pricing model that scales with your team size, ensuring you pay for what you need.
+- **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
+- **No Credit Card Required**: You won't need a credit card to start your free trial.
+- **CodeRabbit Seats**
+ 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.
-### 1. Pro Plan
+---
+
+## **Pro Plan**
-### Features:
+### Features
-- This plan begins with a 7-day free trial, with no credit card required.
-- Summarization of pull requests.
-- Includes line-by-line reviews of all changes in the Pull Request
-- Ability to have conversations with CodeRabbit bot.
-- Reviews on unlimited public and private repositories within the organization.
+- This plan begins with a 7-day free trial, with no credit card required.
+- Summarization of pull requests.
+- Includes line-by-line reviews of all changes in the Pull Request
+- Ability to have conversations with CodeRabbit bot.
+- Reviews on unlimited public and private repositories within the organization.
-### Pricing:
+### Pricing
-- Monthly: $15 per month.
-- Annual: $12 per month billed annually, with a 20% discount.
+- Monthly: $15 per month.
+- Annual: $12 per month billed annually, with a 20% discount.
-### Billing:
+### Billing
-- Billed per participating developer.
+- Billed per participating developer.
-### Usage Limits:
+### Usage Limits
These are the hourly usage limits for each developer per repository:
-- Number of files reviewed per hour: 100 Files
-- Number of reviews per hour (includes incremental reviews): 9
-- Number of conversations per hour: 50
+- Number of files reviewed per hour: 100 Files
+- Number of reviews per hour (includes incremental reviews): 9
+- Number of conversations per hour: 50
+
+---
+
+## **Free Plan**
-### 2. Free Plan
+### Features
-### Features:
+- Starts with a 7-day free trial of the Pro plan.
+- unlimited access on both public and private repositories.
+- Summarization pull requests on private repositories.
+- Reviews pull requests on public repositories.
-- Starts with a 7-day free trial of the Pro plan.
-- unlimited access on both public and private repositories.
-- Summarization pull requests on private repositories.
-- Reviews pull requests on public repositories.
+### Pricing
-### Pricing:
+- $0 per month.
-- $0 per month.
+### Billing
-### Billing:
+- Free forever, no credit card required.
-- Free forever, no credit card required.
+---
-### **Subscription Management**
+## **Subscription Management**
-### 1. Pro Plan
+### Pro Plan
-- GitHub/GitLab organization owners can purchase or make changes to the subscription.
-- You can choose to manually purchase seats and assign them to developers, or have them assigned automatically as developers create pull requests.
-- During the trial period, seat assignment is automatic, but the number of seats can be adjusted when purchasing the subscription.
+- GitHub/GitLab organization owners can purchase or make changes to the subscription.
+- You can choose to manually purchase seats and assign them to developers, or have them assigned automatically as developers create pull requests.
+- During the trial period, seat assignment is automatic, but the number of seats can be adjusted when purchasing the subscription.
-
+
+
-### 2. Free Plan
+### Free Plan
-- Seats are assigned to new developers immediately
+- Seats are assigned to new developers immediately
-
+
+
diff --git a/docs/about/support.md b/docs/about/support.md
index 4c356534..3b09bfa9 100644
--- a/docs/about/support.md
+++ b/docs/about/support.md
@@ -10,11 +10,13 @@ image: "/preview_meta.jpg"
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
<meta name="description" content="Accelerate Code Reviews with AI" />
- <meta property="og:type" content="website" />
- <meta property="og:url" content="https://coderabbit.ai/" />
- <meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
- <meta property="og:description" content="Accelerate Code Reviews with AI" />
- <meta property="og:image" content="/preview_meta.jpg" />
+{" "}
+
+<meta property="og:type" content="website" />
+<meta property="og:url" content="https://coderabbit.ai/" />
+<meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
+<meta property="og:description" content="Accelerate Code Reviews with AI" />
+<meta property="og:image" content="/preview_meta.jpg" />
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
<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
These are the most common questions our support team receives, and you might find an answer here
-### 1. Can I switch between different organizations on CodeRabbit?
+### Can I switch between different organizations on CodeRabbit?
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.
-
+<div align="center"></div>
+<div align="center"></div>
-### 2. Can CodeRabbit subscription be used across multiple organizations?
+### Can CodeRabbit subscription be used across multiple organizations?
Subscription seat are tied to the specific GitHub/GitLab organization under which they are purchased and cannot be used under another organization.
-### 3. Can CodeRabbit review my existing PRs after integrating it?
+### Can CodeRabbit review my existing PRs after integrating it?
CodeRabbit would by default only review new PRs or existing PRs which have a new commits after the app is installed.
You can however use @coderabbitai review command on the PR to trigger a review of existing PRs.
-### 4. Who can add the repositories on CodeRabbit?
+### Who can add the repositories on CodeRabbit?
You need to be GitHub/GitLab admin to add the repositories.
-### 5. Do I need own OpenAI key with CodeRabbit Pro?
+### Do I need own OpenAI key with CodeRabbit Pro?
OpenAI cost is part of the subscription.There is no additional cost for OpenAI.
-### 6. What is the difference between CodeRabbit OSS ai-pr-reviewer and CodeRabbit Pro ?
+### What is the difference between CodeRabbit OSS ai-pr-reviewer and CodeRabbit Pro ?
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.
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.
-### 7. Can I use both CodeRabbit OSS and CodeRabbit Pro together ?
+### Can I use both CodeRabbit OSS and CodeRabbit Pro together ?
You can, but this will result in duplicate reviews. We suggest you use only one of the two.
-### Explore More
-
-To see more common issues faced by CodeRabbit users, visit our FAQ section for detailed answers and solutions to frequently encountered problems.
-
### **Opening a Support Ticket**
To get assistance from our support team, open a ticket using the help icon on the CodeRabbit UI:
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.
-
+
+
+
+:::tip
+To see more common issues faced by CodeRabbit users, visit our FAQ section for detailed answers and solutions to frequently encountered problems.
+:::
### **Community Collaboration**
diff --git a/docs/faq/faq.md b/docs/faq/faq.md
index 78edd68f..b17d648a 100644
--- a/docs/faq/faq.md
+++ b/docs/faq/faq.md
@@ -74,13 +74,14 @@ Yes, you can change it under the repository settings.
There are hourly rate limits for each developer per repository:
-- Number of files reviewed per hour: 200
-- Number of reviews : 3 back to back reviews followed by 4 reviews/hour
-- Number of conversations: 25 back to back messages followed by 50 messages/hr
-
+- Number of files reviewed per hour: 200
+- Number of reviews : 3 back to back reviews followed by 4 reviews/hour
+- Number of conversations: 25 back to back messages followed by 50 messages/hr
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.
-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.
+:::note
+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.
+:::
If you have further questions or need additional information, don't hesitate to reach out to us at [contact@coderabbit.ai](mailto:contact@coderabbit.ai).
diff --git a/docs/get-started/add-repo.md b/docs/get-started/add-repo.md
index ac926bdb..352d6f53 100644
--- a/docs/get-started/add-repo.md
+++ b/docs/get-started/add-repo.md
@@ -28,14 +28,20 @@ To add additional repositories after the sign-up, go to the repositories page wi
Click on the "**Add repositories**" button. Upon clicking, you'll be redirected to GitHub.
-
+
+
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.
-
+:::note
-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.
+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.
+
+
+
+
+:::
### **Need help?**
-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.
+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.
diff --git a/docs/get-started/analytics.md b/docs/get-started/analytics.md
index 1d8954fa..e6cc34f4 100644
--- a/docs/get-started/analytics.md
+++ b/docs/get-started/analytics.md
@@ -5,6 +5,7 @@ slug: /dashboard
description: Accelerate Code Reviews with AI
image: "/preview_meta.jpg"
---
+
<head>
<meta charSet="utf-8" />
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
@@ -22,19 +23,21 @@ image: "/preview_meta.jpg"
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
</head>
-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.
+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.
Dashboard displays the following information:
- **Pull Requests Overview:** View the number of pull requests reviewed by CodeRabbit per week, month, and year.
- **CodeRabbit's Activity:** Understand the metrics related to the number of reviews conducted by CodeRabbit, actionable items, and optional suggestions.
-
+
+
-Access the list of recent pull request reviewed.
+Access the list of recent pull requests reviewed.
-
+
+
### **Need help?**
-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.
\ No newline at end of file
+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.
diff --git a/docs/get-started/images/add1.png b/docs/get-started/images/add1.png
deleted file mode 100644
index ee4708d5..00000000
Binary files a/docs/get-started/images/add1.png and /dev/null differ
diff --git a/docs/get-started/images/add4.png b/docs/get-started/images/add4.png
deleted file mode 100644
index e435e24d..00000000
Binary files a/docs/get-started/images/add4.png and /dev/null differ
diff --git a/docs/get-started/images/analytic2.png b/docs/get-started/images/analytic2.png
deleted file mode 100644
index 32883cd8..00000000
Binary files a/docs/get-started/images/analytic2.png and /dev/null differ
diff --git a/docs/get-started/images/analytic3.png b/docs/get-started/images/analytic3.png
deleted file mode 100644
index 81ea1e04..00000000
Binary files a/docs/get-started/images/analytic3.png and /dev/null differ
diff --git a/docs/get-started/images/cr_add_repo_dark.png b/docs/get-started/images/cr_add_repo_dark.png
new file mode 100644
index 00000000..cd86686e
Binary files /dev/null and b/docs/get-started/images/cr_add_repo_dark.png differ
diff --git a/docs/get-started/images/cr_add_repo_gitlab_dark.png b/docs/get-started/images/cr_add_repo_gitlab_dark.png
new file mode 100644
index 00000000..2f5fcf49
Binary files /dev/null and b/docs/get-started/images/cr_add_repo_gitlab_dark.png differ
diff --git a/docs/get-started/images/cr_add_repo_gitlab_light.png b/docs/get-started/images/cr_add_repo_gitlab_light.png
new file mode 100644
index 00000000..9e14c409
Binary files /dev/null and b/docs/get-started/images/cr_add_repo_gitlab_light.png differ
diff --git a/docs/get-started/images/cr_add_repo_light.png b/docs/get-started/images/cr_add_repo_light.png
new file mode 100644
index 00000000..7ce435b8
Binary files /dev/null and b/docs/get-started/images/cr_add_repo_light.png differ
diff --git a/docs/get-started/images/cr_dash_dark.png b/docs/get-started/images/cr_dash_dark.png
new file mode 100644
index 00000000..49962fcc
Binary files /dev/null and b/docs/get-started/images/cr_dash_dark.png differ
diff --git a/docs/get-started/images/cr_dash_light.png b/docs/get-started/images/cr_dash_light.png
new file mode 100644
index 00000000..cba70af0
Binary files /dev/null and b/docs/get-started/images/cr_dash_light.png differ
diff --git a/docs/get-started/images/cr_history_dark.png b/docs/get-started/images/cr_history_dark.png
new file mode 100644
index 00000000..40cec0d8
Binary files /dev/null and b/docs/get-started/images/cr_history_dark.png differ
diff --git a/docs/get-started/images/cr_history_light.png b/docs/get-started/images/cr_history_light.png
new file mode 100644
index 00000000..115f8841
Binary files /dev/null and b/docs/get-started/images/cr_history_light.png differ
diff --git a/docs/get-started/images/cr_login.png b/docs/get-started/images/cr_login.png
new file mode 100644
index 00000000..dd8f4c6e
Binary files /dev/null and b/docs/get-started/images/cr_login.png differ
diff --git a/docs/get-started/images/cr_login2.png b/docs/get-started/images/cr_login2.png
new file mode 100644
index 00000000..536dc7f2
Binary files /dev/null and b/docs/get-started/images/cr_login2.png differ
diff --git a/docs/get-started/images/cr_login_dark.png b/docs/get-started/images/cr_login_dark.png
new file mode 100644
index 00000000..766ea9e5
Binary files /dev/null and b/docs/get-started/images/cr_login_dark.png differ
diff --git a/docs/get-started/images/signup.png b/docs/get-started/images/signup.png
deleted file mode 100644
index 6ce94ad4..00000000
Binary files a/docs/get-started/images/signup.png and /dev/null differ
diff --git a/docs/get-started/signup.md b/docs/get-started/signup.md
index ba41000c..6a4af0ca 100644
--- a/docs/get-started/signup.md
+++ b/docs/get-started/signup.md
@@ -28,9 +28,10 @@ Signing up for CodeRabbit is quick and easy, allowing you to get started in just
### **Step 1: Getting Started**
-**Login with GitHub or GitLab**: Log in with your GitHub or GitLab account at https://coderabbit.ai/login
+**Login with GitHub or GitLab**: Log in with your GitHub or GitLab account at [https://coderabbit.ai/login](https://coderabbit.ai/login)
-
+
+
### **Step 2: Select Organization**
@@ -44,9 +45,11 @@ After selecting the organization, you will be directed to a GitHub repositories
-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.
+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.
-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.
+:::tip
+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.
+:::
### **Need help?**
diff --git a/docs/guides/coderabbit-commands.md b/docs/guides/coderabbit-commands.md
index 1e6c9129..3e780a58 100644
--- a/docs/guides/coderabbit-commands.md
+++ b/docs/guides/coderabbit-commands.md
@@ -4,6 +4,7 @@ description: Efficiently manage your PR reviews with our intuitive commands. Use
sidebar_label: CodeRabbit Commands
image: "/preview_meta.jpg"
---
+
<head>
<meta charSet="utf-8" />
<meta name="title" content="CodeRabbit Commands" />
@@ -25,26 +26,28 @@ Manage your PR reviews with the following commands:
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:
-- **Pause Reviews**:
+- **Pause Reviews**:
- Use `@coderabbitai pause` in a PR comment to halt ongoing reviews.
-
-- **Resume Reviews**:
+- **Resume Reviews**:
- Enter `@coderabbitai resume` in a PR comment to continue paused reviews.
-
-- **On-Demand Reviews**:
+- **On-Demand Reviews**:
- Disable automatic reviews for your repository to switch to on-demand reviews.
- - 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.
-
-- **Skip Specific PR**:
+ - 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.
+- **Skip Specific PR**:
+
- To exclude a specific PR from review, include `@coderabbitai ignore` in the PR description.
- **Resolve Command**:
+
- Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once.
- **Help Command**:
- You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands.
-**Note:** Ensure you input these commands as PR comments. For direct bot interactions, use review comments on code diffs or files.
+:::note
+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.
+:::
### Feedback
+
If you have suggestions for additional commands or improvements, we would love to hear from you! Please submit your feedback to our support team.
diff --git a/docs/guides/customize-coderabbit.md b/docs/guides/customize-coderabbit.md
index 9d6c951f..aeb0de6e 100644
--- a/docs/guides/customize-coderabbit.md
+++ b/docs/guides/customize-coderabbit.md
@@ -32,7 +32,7 @@ specific requirements. Customizations can be made using one of the below options
Customization defined in the YAML file overrides the settings in the UI.
-#### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit)
+### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit)
You can add a `.coderabbit.yaml` configuration file to your repositories. Below
is a sample YAML file that can be used as a starting point and change as needed:
@@ -73,10 +73,12 @@ chat:
auto_reply: true
```
-**Note**: `.coderabbit.yaml` file should be placed at the root directory of the
+:::note
+`.coderabbit.yaml` file should be placed at the root directory of the
repository.
+:::
-Yaml settings:
+YAML settings:
1. **language**: Set the language for reviews using the ISO language code. For
example, `"fr"` stands for French (default:`en`).
@@ -136,7 +138,7 @@ settings:
path_based_instructions:
- path: "**/*.js"
instructions:
- "Review the javascript code against the google javascript style guide
+ "Review the JavaScript code against the Google JavaScript style guide
and point out any mismatches"
- path: "tests/**/*"
instructions:
@@ -193,18 +195,20 @@ Refer:
</details>
-#### 2. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard)
+### 2. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard)
Reviews can also be customized through the UI under repository settings:
+---
+
### Review Customization[](https://coderabbit.ai/docs/get-started#review-customization)
[](../get-started/images/tailor2.png)
-**Path based instructions :** Provide additional review guidelines based on the
+**Path-based instructions :** Provide additional review guidelines based on the
file paths using glob patterns.
-For further guidance please refer this
+For further guidance, please refer this
section [Prompt Customization](/guides/prompt-customization)
**Language Selection:** Select the natural language in which you want the review
@@ -214,6 +218,8 @@ language is English.
**Disable High Level Summary:** This allows disabling high level summary added
with the pull request description.
+---
+
### Review Filters [](https://coderabbit.ai/docs/get-started#review-filters)
[](../get-started/images/tailor3.png)
diff --git a/docs/guides/prompt-customization.md b/docs/guides/prompt-customization.md
index 7c399ac6..c4ff3fff 100644
--- a/docs/guides/prompt-customization.md
+++ b/docs/guides/prompt-customization.md
@@ -4,6 +4,7 @@ sidebar_label: Prompt Customization
description: Accelerate Code Reviews with AI
image: "/preview_meta.jpg"
---
+
<head>
<meta charSet="utf-8" />
<meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
@@ -21,11 +22,9 @@ image: "/preview_meta.jpg"
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
</head>
-### Path based instructions[](https://coderabbit.ai/docs/prompt-customization#path-based-instructions)
-
-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.
+### Path-based instructions[](https://coderabbit.ai/docs/prompt-customization#path-based-instructions)
-### Overview[](https://coderabbit.ai/docs/prompt-customization#overview)
+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.
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.
@@ -33,17 +32,19 @@ Adding file path prompts allows developers to specify custom instructions for di
**path:** `**/*.js`
-**instructions:** Review the javascript code against the google javascript style guide and point out any mismatches
+**instructions:** Review the JavaScript code against the Google JavaScript style guide and point out any mismatches
**path:** `tests/**.*`
-**instructions:** Review the following unit test code written using the Mocha test library.
+**instructions:** Review the following unit test code written using the Mocha test library.
Ensure that:
The code adheres to best practices associated with Mocha.
Descriptive test names are used to clearly convey the intent of each test.
-### Notes[](https://coderabbit.ai/docs/prompt-customization#best-practices)
+:::note
- Paths accept glob patterns.
- Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something.
-- Test the review feedback on pull requests and tailor as necessary.
+- Test the review feedback on pull requests and tailor as necessary.
+
+:::
diff --git a/docs/integrations/self-hosted-gitlab.md b/docs/integrations/self-hosted-gitlab.md
index 85be8711..27e0f523 100644
--- a/docs/integrations/self-hosted-gitlab.md
+++ b/docs/integrations/self-hosted-gitlab.md
@@ -28,7 +28,7 @@ To initiate the integration, we require specific information. This is essential
### **Step 1: Getting Started**
-**Visit CodeRabbit:** Land on to our login page https://coderabbit.ai/login and select Self-Hosted GitLab
+**Visit CodeRabbit:** Land on to our [Login](https://coderabbit.ai/login) page and select Self-Hosted GitLab
@@ -46,15 +46,15 @@ If this is the first time you are signing up with your instance, we need an admi
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:
-1. Login to your self-hosted instance. Ensure sure you have admin rights.
-2. On the left sidebar, select your avatar.
-3. Select Edit profile.
-4. On the left sidebar, select Access Tokens.
-5. Select Add new token.
-6. Enter a name and expiry date for the token. We need this for the initial setup, so the minimum expiry time is sufficient.
-7. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
-8. Make sure, you select the scope: `api`
-9. Select Create personal access token.
+1. Login to your self-hosted instance. Ensure sure you have admin rights.
+2. On the left sidebar, select your avatar.
+3. Select Edit profile.
+4. On the left sidebar, select Access Tokens.
+5. Select Add new token.
+6. Enter a name and expiry date for the token. We need this for the initial setup, so the minimum expiry time is sufficient.
+7. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
+8. Make sure, you select the scope: `api`
+9. Select Create personal access token.
10. Please note down this token as this will be visible one time only
@@ -64,10 +64,10 @@ GitLab offers an option to generate a personal access token for adding a new use
- Submit the access token.
- We will handle the setup process for you.
- On subsequent visits, your setup will be automatically detected, allowing for direct login.
-
+ 
### **Step 5: Whitelist CodeRabbit IP address**
-Use this CodeRabbit IP if your instance requires IP whitelisting `35.222.179.152/32`
+Use this CodeRabbit IP if your instance requires IP whitelisting `35.222.179.152/32`
-- Furthermore, please refer to our Get Started Guide to make the most of CodeRabbit [here](../get-started/add-repo.md).
+- Furthermore, please refer to our Get Started Guide to make the most of CodeRabbit [here](../get-started/add-repo.md).
diff --git a/src/css/custom.css b/src/css/custom.css
index 634a74f9..1f8d9274 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -9,73 +9,78 @@
/* You can override the default Infima variables here. */
:root {
- --ifm-color-primary: #ff8b53;
- --ifm-color-primary-dark: #29784c;
- --ifm-color-primary-darker: #277148;
- --ifm-color-primary-darkest: #205d3b;
- --ifm-color-primary-light: #33925d;
- --ifm-color-primary-lighter: #359962;
- --ifm-color-primary-lightest: #3cad6e;
- --ifm-code-font-size: 95%;
- --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
- --ifm-navbar-height: 5rem;
+ --ifm-color-primary: #ff8b53;
+ --ifm-color-primary-dark: #29784c;
+ --ifm-color-primary-darker: #277148;
+ --ifm-color-primary-darkest: #205d3b;
+ --ifm-color-primary-light: #33925d;
+ --ifm-color-primary-lighter: #359962;
+ --ifm-color-primary-lightest: #3cad6e;
+ --ifm-code-font-size: 95%;
+ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+ --ifm-navbar-height: 5rem;
}
/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme="dark"] {
- --ifm-color-primary: #ff8b53;
- --ifm-color-primary-dark: #21af90;
- --ifm-color-primary-darker: #1fa588;
- --ifm-color-primary-darkest: #1a8870;
- --ifm-color-primary-light: #29d5b0;
- --ifm-color-primary-lighter: #32d8b4;
- --ifm-color-primary-lightest: #4fddbf;
- --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+ --ifm-color-primary: #ff8b53;
+ --ifm-color-primary-dark: #21af90;
+ --ifm-color-primary-darker: #1fa588;
+ --ifm-color-primary-darkest: #1a8870;
+ --ifm-color-primary-light: #29d5b0;
+ --ifm-color-primary-lighter: #32d8b4;
+ --ifm-color-primary-lightest: #4fddbf;
+ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}
.navbar .navbar__item {
- align-items: center;
- display: flex;
- font-size: 1.25rem;
- font-weight: 700;
+ align-items: center;
+ display: flex;
+ font-size: 1.25rem;
+ font-weight: 700;
}
a[docid="docs"] > svg {
- display: none;
+ display: none;
}
/* Adjustments for mobile view */
@media (max-width: 768px) {
- /* Reduce the logo size for smaller screens */
- .navbar__logo img {
- height: 32px;
- align-items: center;
- }
+ /* Reduce the logo size for smaller screens */
+ .navbar__logo img {
+ height: 32px;
+ align-items: center;
+ }
- /* Reduce the padding around the logo for smaller screens */
- .navbar__logo {
- padding: 2px; /* Adjust the padding for smaller screens */
- }
+ /* Reduce the padding around the logo for smaller screens */
+ .navbar__logo {
+ padding: 2px; /* Adjust the padding for smaller screens */
+ }
}
/* Center the Discord link within its parent */
.navbar__items.navbar__items--right {
- display: flex;
- justify-content: center;
- align-items: center;
+ display: flex;
+ justify-content: center;
+ align-items: center;
}
@media screen and (max-width: 480px) {
- a.navbar__item.navbar__link[docid="docs"] {
- display: none !important;
- }
+ a.navbar__item.navbar__link[docid="docs"] {
+ display: none !important;
+ }
}
@media screen and (max-width: 480px) {
- a.navbar__item.navbar__link[href="https://blog.coderabbit.ai/blog"]
- {
- display: none;
- }
+ a.navbar__item.navbar__link[href="https://blog.coderabbit.ai/blog"]
+ {
+ display: none;
+ }
+}
+
+[data-theme="light"] img[src$="#gh-dark-mode-only"],
+[data-theme="dark"] img[src$="#gh-light-mode-only"] {
+ display: none;
}
/* Light mode Discord icon */