-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update npm dependencies and add docusaurus-json-schema-plugin (#49)
* Update npm dependencies and add docusaurus-json-schema-plugin * Show CodeRabbit config schema from a file
- Loading branch information
Showing
9 changed files
with
834 additions
and
312 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Configure CodeRabbit | ||
sidebar_label: Configure CodeRabbit | ||
description: | ||
CodeRabbit offers various configuration options to tailor the reviews to your | ||
specific requirements. Configuration can be made using one of the below | ||
options. | ||
sidebar_position: 2 | ||
--- | ||
|
||
import SchemaViewer from "@site/src/components/SchemaViewer"; | ||
|
||
CodeRabbit offers various configuration options to tailor the reviews to your | ||
requirements. Configuration can be made using one of the below options, in order | ||
of precedence: | ||
|
||
1. Configure using CodeRabbit YAML file | ||
2. Configure using CodeRabbit UI for each repository | ||
3. Configure using CodeRabbit UI for the organization | ||
|
||
In this guide, we will cover the configuration using a YAML file. | ||
|
||
## Configure CodeRabbit using a YAML File | ||
|
||
You can add a `.coderabbit.yaml` configuration file to the root of your | ||
repositories. Below is a sample YAML file that can be used as a starting point | ||
and changed as needed: | ||
|
||
<SchemaViewer /> | ||
|
||
Refer: | ||
[CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/schema.v2.json). | ||
|
||
Please note that code reviews commence with new pull requests or incremental | ||
commits to existing pull requests once the CodeRabbit app is installed. Should | ||
you have any questions or require assistance, our support team is here to help. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.