Skip to content

Commit f0ec74d

Browse files
committed
Add new images and update links in docusaurus.config.ts and sidebars.ts
1 parent a98442a commit f0ec74d

26 files changed

+23
-127
lines changed

docs/about.md

-52
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/get-started/customize-coderabbit.md renamed to docs/guides/customize-coderabbit.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ made using one of the below options :
3131

3232
Customization defined in the YAML file overrides the settings in the UI.
3333

34-
#### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit#1-customize-coderabbit-using-a-yaml-file)
34+
#### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit)
3535

3636
You can add a `.coderabbit.yaml` configuration file to your repositories.
3737
Below is a sample YAML file that can be used as a starting point and change as needed:
@@ -97,7 +97,7 @@ Yaml settings:
9797

9898
Refer: [CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json).
9999

100-
#### version 1: `deprecated` (Please use version [version 2](/get-started/customize-coderabbit#example-structure-for-version-2))
100+
#### version 1: `deprecated` (Please use version [version 2](/guides/customize-coderabbit))
101101

102102
```yaml
103103
settings:
@@ -156,19 +156,19 @@ Reviews can also be customized through the UI under repository settings:
156156

157157
### Review Customization[](https://coderabbit.ai/docs/get-started#review-customization)
158158

159-
[](./images/tailor2.png)
159+
[](../get-started/images/tailor2.png)
160160

161161
**Path based instructions :** Provide additional review guidelines based on the file paths using glob patterns.
162162

163-
For further guidance please refer this section [Prompt Customization](/get-started/prompt-customization)
163+
For further guidance please refer this section [Prompt Customization](/guides/prompt-customization)
164164

165165
**Language Selection:** Select the natural language in which you want the review feedback. CodeRabbit supports most of the widely used languages. The default language is English.
166166

167167
**Disable High Level Summary:** This allows disabling high level summary added with the pull request description.
168168

169169
### Review Filters [](https://coderabbit.ai/docs/get-started#review-filters)
170170

171-
[](./images/tailor3.png)
171+
[](../get-started/images/tailor3.png)
172172

173173
**Disable Reviews:** Disables automatic code reviews for the repository. Reviews can be initiated on-demand using CodeRabbit commands.
174174

docs/intro.md

-47
This file was deleted.

docs/introduction/about.md renamed to docs/introduction/introduction.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: introduction
33
title: What is CodeRabbit?
4-
sidebar_label: What is CodeRabbit?
4+
sidebar_label: Introduction
55
description: Accelerate Code Reviews with AI
66
image: "/preview_meta.jpg"
77
slug: "/"
@@ -36,7 +36,7 @@ Code reviews remain essential, whether the code is written by a human or a bot.
3636

3737
**CodeRabbit** seamlessly integrates into code repositories using GitHub or GitLab webhooks and monitors events related to Pull Request (PR) and Merge Request (MR) changes. A comprehensive review is performed when a PR or MR is created, and for incremental commits and comments addressed to the bot. The feedback is then sent directly back to the PR or MR.
3838

39-
![](./images/chat.png)
39+
![](../about/./images/chat.png)
4040

4141
## Data, Privacy, and Security.
4242

docusaurus.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const config: Config = {
4747
},
4848
{
4949
to: "https://docs.coderabbit.ai/",
50-
from: "/docs/introduction",
50+
from: "/introduction",
5151
},
5252
],
5353
},

sidebars.ts

+15-10
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,33 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
1212
*/
1313
const sidebars: SidebarsConfig = {
1414
docsSidebar: [
15+
"introduction/introduction",
1516
{
1617
type: "category",
17-
label: "Introduction",
18+
label: "About",
1819
collapsed: false,
19-
items: [
20-
"introduction",
21-
"introduction/features",
22-
"introduction/pricing",
23-
"introduction/support",
24-
],
20+
items: ["about/features", "about/pricing", "about/support"],
2521
},
2622
{
2723
type: "category",
2824
label: "Get Started",
2925
items: [
3026
"get-started/signup",
3127
"get-started/add-repo",
32-
"get-started/customize-coderabbit",
33-
"get-started/prompt-customization",
28+
// "get-started/customize-coderabbit",
29+
// "get-started/prompt-customization",
3430
"get-started/analytics",
31+
// "get-started/coderabbit-commands",
3532
,
36-
"get-started/coderabbit-commands",
33+
],
34+
},
35+
{
36+
type: "category",
37+
label: "Guides",
38+
items: [
39+
"guides/customize-coderabbit",
40+
"guides/prompt-customization",
41+
"guides/coderabbit-commands",
3742
],
3843
},
3944
"faq/faq",

src/pages/index.tsx

-10
This file was deleted.

0 commit comments

Comments
 (0)