Skip to content

Initial ToC overhaul #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/finishing-touches/docstrings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Docstrings generation with CodeRabbit
sidebar_label: Docstrings
title: Generate docstrings
description: Automated docstrings pull requests with CodeRabbit
---

Expand Down
4 changes: 1 addition & 3 deletions docs/getting-started/adding-organizations.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Adding Organizations
title: Add organizations
description: Learn how to add new organizations to CodeRabbit
sidebar_label: Adding Organizations
sidebar_position: 5
---

To add new organizations to CodeRabbit, follow these steps:
Expand Down
4 changes: 1 addition & 3 deletions docs/getting-started/configure-coderabbit.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Configure CodeRabbit
sidebar_label: Configure
title: Add a configuration file
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
---

```mdx-code-block
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When you complete this tutorial, you'll have seen CodeRabbit's code-review featu
For a more general overview of CodeRabbit, see [Introduction](/).

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

## Before you begin
Expand Down
4 changes: 1 addition & 3 deletions docs/getting-started/subscription-management.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Subscription Management
title: Manage your subscription
description: Learn how to manage your CodeRabbit subscription, including billing, plan changes, and seat management
sidebar_label: Subscription Management
sidebar_position: 7
---

This guide covers how to manage your subscription, including accessing billing information, changing plans, and adjusting your seat count.
Expand Down
4 changes: 1 addition & 3 deletions docs/getting-started/support.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Support
sidebar_label: Support
title: Get support
description: Get help with CodeRabbit and find answers to common questions.
sidebar_position: 3
---

Welcome to CodeRabbit Support. Please refer to the following sections for
Expand Down
4 changes: 1 addition & 3 deletions docs/getting-started/upgrading-permissions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Upgrading App Permissions
title: Set permissions
description: Learn how to upgrade CodeRabbit's GitHub App permissions when new features are added
sidebar_label: Upgrading Permissions
sidebar_position: 6
---

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:
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/agent_chat.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Chat and Agentic Chat
sidebar_label: Chat and Agentic Chat
title: Discuss code reviews with CodeRabbit
description: Learn about CodeRabbit Pro's chat and agentic chat system
sidebar_position: 3
---

# CodeRabbit Chat
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/commands.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Commands
sidebar_label: Commands
title: Control and manage code reviews
description: Learn how to control CodeRabbit using commands in pull request comments
sidebar_position: 1
---

# CodeRabbit Commands
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/custom-reports.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Custom Reports
sidebar_label: Custom Reports
title: Customize reports
description: Learn how to create custom reports with CodeRabbit Pro's flexible reporting system
sidebar_position: 8
---

```mdx-code-block
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/issue-chat.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Issue Chat
sidebar_label: Issue Chat
title: Discuss issues and plan solutions
description: Learn how to use CodeRabbit's chat capabilities within issues
sidebar_position: 4
---

```mdx-code-block
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/issue-creation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Issue Creation
sidebar_label: Issue Creation
title: Create issues
description: Learn how to create issues directly through CodeRabbit
sidebar_position: 5
---

```mdx-code-block
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/linked-issues.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Linked Issues
sidebar_label: Linked Issues
title: Work with linked Issues
description: Learn how to effectively use linked issues with CodeRabbit for better pull request assessments
sidebar_position: 6
---

# Linked Issues
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/ondemand-reports.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: On-demand Reports
sidebar_label: On-demand Reports
title: Generate reports
description: CodeRabbit offers a way to generate on-demand reports using a simple API request
sidebar_position: 9
---

```mdx-code-block
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/scheduled-reports.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Scheduled Reports
sidebar_label: Scheduled Reports
title: Schedule reports
description: Learn how to set up automated recurring reports with CodeRabbit Pro
sidebar_position: 7
---

```mdx-code-block
Expand Down
4 changes: 1 addition & 3 deletions docs/integrations/code-graph-analysis.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Code Graph Analysis
title: Analyze your code changes
description: Learn about CodeRabbit's intelligent graph-based code analysis.
sidebar_label: Code Graph Analysis
sidebar_position: 6
---

# CodeRabbit Code Graph Analysis
Expand Down
4 changes: 1 addition & 3 deletions docs/integrations/issue-integrations.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Issue Integrations
title: Integrate issue tracking
description: Learn about CodeRabbit's integrations with issue tracking systems like Jira and Linear.
sidebar_label: Issue Integrations
sidebar_position: 5
---

CodeRabbit integrates with popular issue tracking systems to provide context from linked and related issues while reviewing code.
Expand Down
4 changes: 1 addition & 3 deletions docs/integrations/knowledge-base.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Knowledge Base
title: Apply your code review preferences
description: Learn about CodeRabbit's internal knowledge base and its integrations with external services.
sidebar_label: Knowledge Base
sidebar_position: 4
---

CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience.
Expand Down
4 changes: 1 addition & 3 deletions docs/platforms/platforms.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Supported Git Platforms
sidebar_label: Supported Git Platforms
title: Integrate with Git platforms
description: Overview of CodeRabbit's supported Git platforms.
sidebar_position: 1
---

CodeRabbit supports various Git platforms to provide code review for your repositories. For the cloud-hosted Git platforms, you can [login][login] to CodeRabbit and add your repositories. The following platforms are supported:
Expand Down
4 changes: 1 addition & 3 deletions docs/tools/tools.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Supported Tools
sidebar_label: Supported Tools
title: Configure third-party tool use
description: Overview of CodeRabbit's supported linters and security analysis tools.
sidebar_position: 1
---

```mdx-code-block
Expand Down
149 changes: 144 additions & 5 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,152 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"
const sidebars: SidebarsConfig = {
docsSidebar: [
{
type: "autogenerated",
dirName: ".",
type: "category",
collapsed: false,
label: "Get started with CodeRabbit",
items: ["overview/introduction", "getting-started/quickstart"],
},
{
type: "link",
label: "API Reference",
href: "https://api.coderabbit.ai/api/swagger/",
type: "category",
collapsed: false,
label: "Add CodeRabbit to your repository",
items: [
"platforms/platforms",
{
type: "category",
collapsed: true,
label: "Supported Git platforms",
items: [
"platforms/github-com",
"platforms/github-enterprise-server",
"platforms/gitlab-com",
"platforms/self-hosted-gitlab",
"platforms/azure-devops",
"platforms/bitbucket-cloud",
],
},
"getting-started/adding-organizations",
"getting-started/upgrading-permissions",
{
type: "category",
collapsed: true,
label: "Self-host CodeRabbit",
items: [
"self-hosted/github",
"self-hosted/gitlab",
"self-hosted/azure-devops",
"self-hosted/bitbucket",
],
},
],
},
{
type: "category",
collapsed: false,
label: "Configure CodeRabbit",
items: [
"getting-started/configure-coderabbit",
"integrations/knowledge-base",
"tools/tools",
],
},
{
type: "category",
collapsed: false,
label: "Review pull requests",
items: [
"guides/commands",
"guides/agent_chat",
{
type: "category",
collapsed: false,
label: "Analyze and improve your code",
items: [
"integrations/code-graph-analysis",
"finishing-touches/docstrings",
],
},
],
},
{
type: "category",
collapsed: false,
label: "Create and resolve issues",
items: [
"integrations/issue-integrations",
"guides/issue-chat",
"guides/issue-creation",
"guides/linked-issues",
],
},
{
type: "category",
collapsed: false,
label: "Generate reports",
items: [
"guides/ondemand-reports",
"guides/custom-reports",
"guides/scheduled-reports",
],
},
{
type: "category",
collapsed: false,
label: "Reference",
items: [
{
type: "link",
label: "CodeRabbit API",
href: "https://api.coderabbit.ai/api/swagger/",
},
{
type: "category",
label: "Supported tools",
collapsed: true,
items: [
"tools/actionlint",
"tools/biome",
"tools/buf",
"tools/checkov",
"tools/circleci",
"tools/cppcheck",
"tools/detekt",
"tools/eslint",
"tools/gitleaks",
"tools/golangci-lint",
"tools/hadolint",
"tools/languagetool",
"tools/markdownlint",
"tools/oxlint",
"tools/phpstan",
"tools/pipeline-remediation",
"tools/pmd",
"tools/prisma-lint",
"tools/regal",
"tools/rubocop",
"tools/ruff",
"tools/semgrep",
"tools/shellcheck",
"tools/sqlfluff",
"tools/swiftlint",
"tools/yamllint",
],
},
],
},
{
type: "category",
collapsed: false,
label: "Resources",
items: [
"getting-started/support",
"getting-started/subscription-management",
"overview/why-coderabbit",
"faq",
"early-access",
"future-development",
"changelog",
],
},
],
}
Expand Down