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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 6, 2025
Merged

Initial ToC overhaul #301

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6383c3b
Replace the autogenerated table of contents with a manually arranged …
jmacdotorg Apr 30, 2025
49b4a71
Fix a bad search-and-replace
jmacdotorg Apr 30, 2025
ffc9d0b
Prettier-ized.
jmacdotorg Apr 30, 2025
434c6d0
Merge branch 'main' into toc-overhaul
aravindputrevu May 6, 2025
861a7ff
Merge branch 'main' into toc-overhaul
jmacdotorg May 6, 2025
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
Prev Previous commit
Next Next commit
Prettier-ized.
  • Loading branch information
@jmacdotorg
jmacdotorg committed Apr 30, 2025
commit ffc9d0b0679e48463dd921c282e6d060559014d6
305 changes: 151 additions & 154 deletions sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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