Skip to content

Commit 9fcf1a0

Browse files
authored
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
1 parent 26743c0 commit 9fcf1a0

9 files changed

+834
-312
lines changed

docs/guides/configure-coderabbit.md

-256
This file was deleted.

docs/guides/configure-coderabbit.mdx

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Configure CodeRabbit
3+
sidebar_label: Configure CodeRabbit
4+
description:
5+
CodeRabbit offers various configuration options to tailor the reviews to your
6+
specific requirements. Configuration can be made using one of the below
7+
options.
8+
sidebar_position: 2
9+
---
10+
11+
import SchemaViewer from "@site/src/components/SchemaViewer";
12+
13+
CodeRabbit offers various configuration options to tailor the reviews to your
14+
requirements. Configuration can be made using one of the below options, in order
15+
of precedence:
16+
17+
1. Configure using CodeRabbit YAML file
18+
2. Configure using CodeRabbit UI for each repository
19+
3. Configure using CodeRabbit UI for the organization
20+
21+
In this guide, we will cover the configuration using a YAML file.
22+
23+
## Configure CodeRabbit using a YAML File
24+
25+
You can add a `.coderabbit.yaml` configuration file to the root of your
26+
repositories. Below is a sample YAML file that can be used as a starting point
27+
and changed as needed:
28+
29+
<SchemaViewer />
30+
31+
Refer:
32+
[CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/schema.v2.json).
33+
34+
Please note that code reviews commence with new pull requests or incremental
35+
commits to existing pull requests once the CodeRabbit app is installed. Should
36+
you have any questions or require assistance, our support team is here to help.

docs/guides/review-instructions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 3
99
---
1010

1111
The guide explains how to add custom review instructions for the entire project.
12-
Also, see the guide on how to [configure CodeRabbit](./configure-coderabbit.md).
12+
Also, see the guide on how to [configure CodeRabbit](./configure-coderabbit.mdx).
1313

1414
### Path-based instructions {#path-based}
1515

docusaurus.config.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ const config: Config = {
111111
],
112112
],
113113

114+
themes: ["docusaurus-json-schema-plugin"],
115+
114116
scripts: [
115117
"https://buttons.github.io/buttons.js",
116118
"https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
@@ -167,9 +169,6 @@ const config: Config = {
167169

168170
// Optional: path for search page that enabled by default (`false` to disable it)
169171
searchPagePath: "search",
170-
171-
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
172-
insights: false,
173172
},
174173
} satisfies Preset.ThemeConfig,
175174
};

0 commit comments

Comments
 (0)