Skip to content

Commit 8831f9b

Browse files
Initial ToC overhaul (#301)
* Replace the autogenerated table of contents with a manually arranged ToC defined in sidebars.ts. Remove material related to ToC autogeneration from various pages' front matter. Reorder, reorganize, and retitle pages according to the new information architecture plan. Standardize page titles to use sentence case. * Fix a bad search-and-replace * Prettier-ized. --------- Co-authored-by: Aravind Putrevu <aravind.putrevu@gmail.com>
1 parent eb25e10 commit 8831f9b

21 files changed

+164
-62
lines changed

docs/finishing-touches/docstrings.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
title: Docstrings generation with CodeRabbit
3-
sidebar_label: Docstrings
2+
title: Generate docstrings
43
description: Automated docstrings pull requests with CodeRabbit
54
---
65

docs/getting-started/adding-organizations.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: Adding Organizations
2+
title: Add organizations
33
description: Learn how to add new organizations to CodeRabbit
4-
sidebar_label: Adding Organizations
5-
sidebar_position: 5
64
---
75

86
To add new organizations to CodeRabbit, follow these steps:

docs/getting-started/configure-coderabbit.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
title: Configure CodeRabbit
3-
sidebar_label: Configure
2+
title: Add a configuration file
43
description:
54
CodeRabbit offers various configuration options to tailor the reviews to your
65
specific requirements. Configuration can be made using one of the below
76
options.
8-
sidebar_position: 2
97
---
108

119
```mdx-code-block

docs/getting-started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ When you complete this tutorial, you'll have seen CodeRabbit's code-review featu
1919
For a more general overview of CodeRabbit, see [Introduction](/).
2020

2121
:::note
22-
While this tutorial focuses on GitHub, CodeRabbit also works with GitLab, Azure DevOps, and Bitbucket. For more information, see [Supported Git Platforms](/platforms/).
22+
While this tutorial focuses on GitHub, CodeRabbit also works with GitLab, Azure DevOps, and Bitbucket. For more information, see [Integrate with Git platforms](/platforms/).
2323
:::
2424

2525
## Before you begin

docs/getting-started/subscription-management.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: Subscription Management
2+
title: Manage your subscription
33
description: Learn how to manage your CodeRabbit subscription, including billing, plan changes, and seat management
4-
sidebar_label: Subscription Management
5-
sidebar_position: 7
64
---
75

86
This guide covers how to manage your subscription, including accessing billing information, changing plans, and adjusting your seat count.

docs/getting-started/support.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: Support
3-
sidebar_label: Support
2+
title: Get support
43
description: Get help with CodeRabbit and find answers to common questions.
5-
sidebar_position: 3
64
---
75

86
Welcome to CodeRabbit Support. Please refer to the following sections for

docs/getting-started/upgrading-permissions.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: Upgrading App Permissions
2+
title: Set permissions
33
description: Learn how to upgrade CodeRabbit's GitHub App permissions when new features are added
4-
sidebar_label: Upgrading Permissions
5-
sidebar_position: 6
64
---
75

86
Sometimes when we add new features to CodeRabbit, we need to request additional GitHub permissions. If you see a warning about permissions or resources not being accessible, you'll need to approve the new permissions. Here's how to do it:

docs/guides/agent_chat.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: Chat and Agentic Chat
3-
sidebar_label: Chat and Agentic Chat
2+
title: Discuss code reviews with CodeRabbit
43
description: Learn about CodeRabbit Pro's chat and agentic chat system
5-
sidebar_position: 3
64
---
75

86
# CodeRabbit Chat

docs/guides/commands.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: Commands
3-
sidebar_label: Commands
2+
title: Control and manage code reviews
43
description: Learn how to control CodeRabbit using commands in pull request comments
5-
sidebar_position: 1
64
---
75

86
# CodeRabbit Commands

docs/guides/custom-reports.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: Custom Reports
3-
sidebar_label: Custom Reports
2+
title: Customize reports
43
description: Learn how to create custom reports with CodeRabbit Pro's flexible reporting system
5-
sidebar_position: 8
64
---
75

86
```mdx-code-block

0 commit comments

Comments
 (0)