Skip to content

Commit

Permalink
Update npm dependencies and add docusaurus-json-schema-plugin (#49)
Browse files Browse the repository at this point in the history
* Update npm dependencies and add docusaurus-json-schema-plugin

* Show CodeRabbit config schema from a file
  • Loading branch information
hasit authored Jun 14, 2024
1 parent 26743c0 commit 9fcf1a0
Show file tree
Hide file tree
Showing 9 changed files with 834 additions and 312 deletions.
256 changes: 0 additions & 256 deletions docs/guides/configure-coderabbit.md

This file was deleted.

36 changes: 36 additions & 0 deletions docs/guides/configure-coderabbit.mdx
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.
2 changes: 1 addition & 1 deletion docs/guides/review-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 3
---

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

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

Expand Down
5 changes: 2 additions & 3 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ const config: Config = {
],
],

themes: ["docusaurus-json-schema-plugin"],

scripts: [
"https://buttons.github.io/buttons.js",
"https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
Expand Down Expand Up @@ -167,9 +169,6 @@ const config: Config = {

// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: "search",

// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,
},
} satisfies Preset.ThemeConfig,
};
Expand Down
Loading

0 comments on commit 9fcf1a0

Please sign in to comment.