From 6383c3b32cf36b2c7e8a6f6c84c60f2d02043eda Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Wed, 30 Apr 2025 12:25:32 -0400 Subject: [PATCH 1/3] 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. --- docs/finishing-touches/docstrings.md | 3 +- docs/getting-started/adding-organizations.md | 4 +- docs/getting-started/configure-coderabbit.md | 4 +- docs/getting-started/quickstart.md | 2 +- .../subscription-management.md | 4 +- docs/getting-started/support.md | 4 +- docs/getting-started/upgrading-permissions.md | 4 +- docs/guides/agent_chat.md | 4 +- docs/guides/commands.md | 4 +- docs/guides/custom-reports.md | 4 +- docs/guides/issue-chat.md | 4 +- docs/guides/issue-creation.md | 4 +- docs/guides/linked-issues.md | 4 +- docs/guides/ondemand-reports.md | 4 +- docs/guides/scheduled-reports.md | 4 +- docs/integrations/code-graph-analysis.md | 4 +- docs/integrations/issue-integrations.md | 4 +- docs/integrations/knowledge-base.md | 4 +- docs/platforms/platforms.md | 4 +- docs/tools/tools.md | 4 +- sidebars.ts | 166 ++++++++++++++++-- 21 files changed, 174 insertions(+), 69 deletions(-) diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md index f57ecd65..5d78366e 100644 --- a/docs/finishing-touches/docstrings.md +++ b/docs/finishing-touches/docstrings.md @@ -1,6 +1,5 @@ --- -title: Docstrings generation with CodeRabbit -sidebar_label: Docstrings +title: Generate docstrings description: Automated docstrings pull requests with CodeRabbit --- diff --git a/docs/getting-started/adding-organizations.md b/docs/getting-started/adding-organizations.md index 81fa8cf6..5f4b635b 100644 --- a/docs/getting-started/adding-organizations.md +++ b/docs/getting-started/adding-organizations.md @@ -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: diff --git a/docs/getting-started/configure-coderabbit.md b/docs/getting-started/configure-coderabbit.md index 09bcb8b3..e8ee2e06 100644 --- a/docs/getting-started/configure-coderabbit.md +++ b/docs/getting-started/configure-coderabbit.md @@ -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 diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 26d50f53..e566c8a1 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -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 diff --git a/docs/getting-started/subscription-management.md b/docs/getting-started/subscription-management.md index 31fb9ffe..4483ce78 100644 --- a/docs/getting-started/subscription-management.md +++ b/docs/getting-started/subscription-management.md @@ -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. diff --git a/docs/getting-started/support.md b/docs/getting-started/support.md index 2014965c..9b1ef18b 100644 --- a/docs/getting-started/support.md +++ b/docs/getting-started/support.md @@ -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 diff --git a/docs/getting-started/upgrading-permissions.md b/docs/getting-started/upgrading-permissions.md index 7980bd09..c5553abe 100644 --- a/docs/getting-started/upgrading-permissions.md +++ b/docs/getting-started/upgrading-permissions.md @@ -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: diff --git a/docs/guides/agent_chat.md b/docs/guides/agent_chat.md index f76c4931..4073951a 100644 --- a/docs/guides/agent_chat.md +++ b/docs/guides/agent_chat.md @@ -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 diff --git a/docs/guides/commands.md b/docs/guides/commands.md index a2a2f70b..f7cbe002 100644 --- a/docs/guides/commands.md +++ b/docs/guides/commands.md @@ -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 diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 30655bfb..c006207a 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -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 diff --git a/docs/guides/issue-chat.md b/docs/guides/issue-chat.md index 22de8959..ee4f83a7 100644 --- a/docs/guides/issue-chat.md +++ b/docs/guides/issue-chat.md @@ -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 diff --git a/docs/guides/issue-creation.md b/docs/guides/issue-creation.md index 7c461477..f6228b57 100644 --- a/docs/guides/issue-creation.md +++ b/docs/guides/issue-creation.md @@ -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 diff --git a/docs/guides/linked-issues.md b/docs/guides/linked-issues.md index 3528f0a9..b8768c3d 100644 --- a/docs/guides/linked-issues.md +++ b/docs/guides/linked-issues.md @@ -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 diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md index 471dc04c..41dbe9bb 100644 --- a/docs/guides/ondemand-reports.md +++ b/docs/guides/ondemand-reports.md @@ -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 diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md index 8c56b465..44a11f56 100644 --- a/docs/guides/scheduled-reports.md +++ b/docs/guides/scheduled-reports.md @@ -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 diff --git a/docs/integrations/code-graph-analysis.md b/docs/integrations/code-graph-analysis.md index dd0bd582..5958640a 100644 --- a/docs/integrations/code-graph-analysis.md +++ b/docs/integrations/code-graph-analysis.md @@ -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 diff --git a/docs/integrations/issue-integrations.md b/docs/integrations/issue-integrations.md index a153839b..0ad69f54 100644 --- a/docs/integrations/issue-integrations.md +++ b/docs/integrations/issue-integrations.md @@ -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. diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index c15f2f9f..61ff141e 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -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. diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md index 8114c500..996089fc 100644 --- a/docs/platforms/platforms.md +++ b/docs/platforms/platforms.md @@ -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: diff --git a/docs/tools/tools.md b/docs/tools/tools.md index cb0a01a8..113c2fee 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -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 diff --git a/sidebars.ts b/sidebars.ts index 5f41290e..59789339 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -27,17 +27,159 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs" Create as many sidebars as you want. */ const sidebars: SidebarsConfig = { - docsSidebar: [ - { - type: "autogenerated", - dirName: ".", - }, - { - type: "link", - label: "API Reference", - href: "https://api.coderabbit.ai/api/swagger/", - }, - ], -} + docsSidebar: [ + { + type: 'category', + collapsed: false, + label: 'Get started with CodeRabbit', + items: [ + 'overview/introduction', + 'getting-started/quickstart', + ], + }, + { + 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: + }, + { + 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', + ], + }, + ], +}; export default sidebars From 49b4a71e13d5b4b198f79cdb84c6357ac7f9c116 Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Wed, 30 Apr 2025 12:40:09 -0400 Subject: [PATCH 2/3] Fix a bad search-and-replace --- sidebars.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars.ts b/sidebars.ts index 59789339..35224222 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -128,7 +128,7 @@ const sidebars: SidebarsConfig = { { type: 'link', label: 'CodeRabbit API', - href: 'https: + href: 'https://api.coderabbit.ai/api/swagger/', }, { type: 'category', From ffc9d0b0679e48463dd921c282e6d060559014d6 Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Wed, 30 Apr 2025 12:46:26 -0400 Subject: [PATCH 3/3] Prettier-ized. --- sidebars.ts | 305 ++++++++++++++++++++++++++-------------------------- 1 file changed, 151 insertions(+), 154 deletions(-) diff --git a/sidebars.ts b/sidebars.ts index 35224222..8e701fc2 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -27,159 +27,156 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs" Create as many sidebars as you want. */ const sidebars: SidebarsConfig = { - docsSidebar: [ - { - type: 'category', - collapsed: false, - label: 'Get started with CodeRabbit', - items: [ - 'overview/introduction', - 'getting-started/quickstart', - ], - }, - { - 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', - ], - }, - ], -}; + docsSidebar: [ + { + type: "category", + collapsed: false, + label: "Get started with CodeRabbit", + items: ["overview/introduction", "getting-started/quickstart"], + }, + { + 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", + ], + }, + ], +} export default sidebars