refactor(docs): reorganize navigation structure

- Move content under logical categories (about, getting-started, guides) - Fix redirect paths and config for new structure - Update sidebars.ts to match folder hierarchy - Add quickstart guide under getting-started Signed-off-by: Ankur Tyagi <[email protected]>
coderabbitai · tyaga001 · Dec 5, 2024 · Nov 27, 2024 · Nov 28, 2024 · Dec 3, 2024
commit 10fb9041b60e9cc28bf1df312e3250505bf7842e
diff --git a/docs/about/_category_.yml b/docs/about/_category_.yml
@@ -1,4 +1,4 @@
-label: About
-position: 2
+label: Plateform
+position: 3
 collapsible: true
-collapsed: true
+collapsed: false
diff --git a/docs/getting-started/_category_.yml b/docs/getting-started/_category_.yml
@@ -0,0 +1,4 @@
+label: Getting Started
+position: 2
+collapsible: true
+collapsed: false
diff --git a/docs/configure-coderabbit.md → docs/getting-started/configure-coderabbit.md b/docs/configure-coderabbit.md → docs/getting-started/configure-coderabbit.md
@@ -1,6 +1,6 @@
 ---
 title: Configure CodeRabbit
-sidebar_label: Configure CodeRabbit
+sidebar_label: Configure
 description:
   CodeRabbit offers various configuration options to tailor the reviews to your
   specific requirements. Configuration can be made using one of the below

diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md
@@ -0,0 +1,59 @@
+---
+title: Playing with CodeRabbit
+sidebar_label: Quickstart
+description: Get started with CodeRabbit in less than 2 minutes
+sidebar_position: 1
+---
+
+# Quickstart Guide
+
+:::note
+Get started with CodeRabbit in three simple steps. No complex configuration needed.
+:::
+
+## Steps to Enable CodeRabbit
+
+1. **Sign In with GitHub**
+
+- Visit [coderabbit.ai](https://coderabbit.ai)
+- Click "Sign in with GitHub"
+- Authorize CodeRabbit
+
+![Login with GitHub - CodeRabbit](/img/getting-started/login-with-github.png)
+
+2. **Add Your Repository**
+
+- Go to your [Dashboard](https://app.coderabbit.ai/dashboard)
+- Click "Add Repositories"
+- Select the repositories you want to enable
+
+![CodeRabbit Dashboard](/img/getting-started/coderabbit-dashboard.png)
+
+3. **You're Done 🎉**
+
+- CodeRabbit will automatically start reviewing your Pull Requests
+- Default configuration works out of the box
+- No additional setup needed
+
+## What's Next?
+
+- Watch CodeRabbit review your next PR automatically
+
+Here's an example of CodeRabbit in action:
+
+![CodeRabbit PR Review Example](/img/getting-started/pr-example.png)
+
+[View live example PR](https://github.com/tyaga001/devtoolsacademy/pull/39)
+
+- [Configure CodeRabbit](/getting-started/configure-coderabbit) (optional)
+- [Add custom review instructions](/guides/review-instructions) (optional)
+
+## Need Help?
+
+- Join our [Discord community](https://discord.gg/coderabbit) for support
+- Check out our [FAQ](/faq)
+- Contact [[email protected]](mailto:[email protected])
+
+:::tip
+CodeRabbit starts working immediately. You can customize its behavior later when needed.
+:::
diff --git a/docs/guides/_category_.yml b/docs/guides/_category_.yml
@@ -1,4 +1,4 @@
 label: Guides
 position: 6
 collapsible: true
-collapsed: true
+collapsed: false
diff --git a/docs/guides/review-instructions.md b/docs/guides/review-instructions.md
@@ -9,7 +9,7 @@ sidebar_position: 3
 ---
 
 The guide explains how to add custom review instructions for the entire project.
-Also, see the guide on how to [configure CodeRabbit](../configure-coderabbit.md).
+Also, see the guide on how to [configure CodeRabbit](/getting-started/configure-coderabbit).
 
 ### Path-based instructions {#path-based}
 

diff --git a/docs/integrations/_category_.yml b/docs/integrations/_category_.yml
@@ -1,4 +1,4 @@
 label: Integrations
 position: 7
 collapsible: true
-collapsed: true
+collapsed: false
diff --git a/docs/overview/_category_.yml b/docs/overview/_category_.yml
@@ -0,0 +1,4 @@
+label: Overview
+position: 1
+collapsible: true
+collapsed: false
diff --git a/docs/introduction.md → docs/overview/introduction.md b/docs/introduction.md → docs/overview/introduction.md
@@ -1,6 +1,6 @@
 ---
-id: Get Started
-title: Get Started
+id: introduction
+title: Introduction
 sidebar_label: Introduction
 sidebar_position: 1
 description:

diff --git a/docs/overview/why-coderabbit.md b/docs/overview/why-coderabbit.md
@@ -0,0 +1,163 @@
+---
+id: why-coderabbit
+title: Why CodeRabbit?
+sidebar_label: Why CodeRabbit?
+sidebar_position: 2
+description: CodeRabbit is AI-powered code reviews built for modern development teams
+---
+
+# Why CodeRabbit?
+
+Looking back at CodeRabbit's journey, our fundamental mission remains unchanged:
+
+> To build the best code review experience in the cloud
+
+This is our core mission today. It's clear to us that as development teams grow and codebases become more complex, manual code reviews become increasingly challenging and time-consuming. No one wants to spend hours reviewing code when they could be building features.
+
+## Real-World Code Reviews
+
+> CodeRabbit currently processes [Over 470,000 pull requests](https://github.com/search?q=coderabbitai&type=pullrequests) have been reviewed by CodeRabbit across multiple languages including TypeScript, Go, Python, JavaScript, Java, Rust, C#, and PHP.
+
+:::tip See it in action
+Browse through real-world examples of CodeRabbit's reviews on GitHub to see how it helps developers write better code every day.
+:::
+
+## The Problem With Traditional Code Reviews
+
+As engineering teams scale, several critical issues emerge:
+
+1. **Review Latency** - PRs often sit for days waiting for review, blocking feature delivery
+2. **Inconsistent Quality** - Different code reviewers focus on different aspects
+3. **Knowledge Silos** - Critical insights stay trapped with individual code reviewers
+4. **Context Switching** - Developers lose focus when reviewing large PRs
+5. **Scale Limitations** - Senior developers become review bottlenecks
+
+## CodeRabbit is AI-Powered
+
+CodeRabbit leverages advanced AI to provide intelligent, context-aware code reviews.
+
+Our AI engine understands not just the syntax, but the intent and context of code changes. This enables reviews that go beyond simple style checks to provide meaningful insights about:
+
+- Security vulnerabilities
+- Performance optimizations
+- Design patterns
+- Best practices
+- Documentation completeness
+
+:::tip Did you know?
+CodeRabbit's AI model is trained on millions of code reviews and continuously learns from user feedback to improve its suggestions.
+:::
+
+## CodeRabbit is Context-Aware
+
+A review system that understands your codebase and team preferences.
+
+Unlike traditional automated review tools that apply generic rules, CodeRabbit:
+
+- Learns from your team's coding patterns
+- Understands your project's architecture
+- Considers the full context of changes
+- Adapts to your team's preferences
+- Provides relevant, actionable feedback
+
+## CodeRabbit is Fully Managed
+
+Leave the infrastructure management to us.
+
+Being fully managed means CodeRabbit:
+
+- Automatically scales with your needs
+- Requires zero maintenance
+- Provides enterprise-grade security
+- Ensures high availability
+- Handles updates seamlessly
+
+## CodeRabbit is Platform Agnostic
+
+Supporting all major Git platforms and development workflows.
+
+CodeRabbit integrates seamlessly with:
+
+- GitHub
+- GitLab
+- Azure DevOps
+
+And supports all major programming languages and frameworks without requiring any special configuration.
+
+## Who should use CodeRabbit?
+
+### Individual Developers
+
+- Get expert-level code reviews instantly
+- Learn best practices through AI suggestions
+- Improve code quality before team review
+
+### Development Teams
+
+- Standardize review processes
+- Reduce review bottlenecks
+- Share knowledge across the team
+- Maintain consistent code quality
+
+### Enterprises
+
+- Scale code review processes efficiently
+- Enforce security and compliance standards
+- Reduce technical debt
+- Accelerate development cycles
+
+:::tip Free for Open Source
+CodeRabbit is completely **FREE** for open-source projects. Our architecture enables us to provide a sustainable free tier that includes:
+
+- Unlimited public repositories
+- Full feature access
+- No credit card required
+  :::
+
+## CodeRabbit Doesn't Lock You In
+
+Built on open standards, easy to integrate and customize.
+
+CodeRabbit:
+
+- Works with your existing Git workflow
+- Requires minimal configuration
+- Supports standard code review protocols
+- Allows easy export of review data
+- Integrates with popular development tools
+
+## CodeRabbit Makes Code Reviews Easy
+
+Set up automated code reviews in minutes.
+
+1. Log in with GitHub, GitLab, or Azure DevOps
+2. Select repositories to review
+3. Create a pull request
+4. Watch CodeRabbit provide instant feedback
+
+```bash
+# Example review feedback time
+Traditional Review: 24-48 hours
+CodeRabbit Review: < 5 minutes
+```
+
+## Data Privacy and Security
+
+Your code's security is our top priority.
+
+- **SOC2 Type II Certified**
+- **GDPR Compliant**
+- **Zero Data Retention**: Reviews are ephemeral
+- **Isolated Environments**: Your code stays private
+- **No Training**: Your code is never used to train models
+
+## Are you ready?
+
+Join thousands of developers who are already benefiting from AI-powered code reviews.
+
+After signing up, join our active Discord community where you'll find CodeRabbit users and team members ready to help you get the most out of your code reviews.
+
+<div style={{display: 'flex', gap: '10px', marginTop: '20px'}}>
+  <a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Sign Up Free</a>
+  <a href="https://discord.gg/coderabbit" className="button button--secondary button--lg">Join Discord</a>
+</div>
diff --git a/docs/platforms/_category_.yaml b/docs/platforms/_category_.yaml
@@ -1,4 +1,4 @@
 label: Supported Git Platforms
-position: 5
+position: 4
 collapsible: true
-collapsed: true
+collapsed: false
diff --git a/docs/self-hosted/_category_.yaml b/docs/self-hosted/_category_.yaml
@@ -1,4 +1,4 @@
 label: Self-Hosted CodeRabbit
 position: 8
 collapsible: true
-collapsed: true
+collapsed: false
diff --git a/docs/tools/_category_.yml b/docs/tools/_category_.yml
@@ -1,4 +1,4 @@
 label: Supported Tools
-position: 4
+position: 5
 collapsible: true
 collapsed: true
@@ -42,19 +42,19 @@ const config: Config = {
 				redirects: [
 					{
 						from: "/get-started",
-						to: "/configure-coderabbit",
+						to: "/getting-started/configure-coderabbit",
 					},
 					{
 						from: "/guides/customize-coderabbit",
-						to: "/configure-coderabbit",
+						to: "/getting-started/configure-coderabbit",
 					},
 					{
 						from: "/guides/prompt-customization",
 						to: "/guides/review-instructions",
 					},
 					{
 						from: "/guides/configure-coderabbit",
-						to: "/configure-coderabbit",
+						to: "/getting-started/configure-coderabbit",
 					},
 					{
 						from: "/integrations/saas-gitlab",
@@ -103,6 +103,7 @@ const config: Config = {
 				docs: {
 					editUrl: "https://github.com/coderabbitai/coderabbit-docs/edit/main/",
 					sidebarPath: "./sidebars.ts",
+					path: "docs",
 					routeBasePath: "/",
 					breadcrumbs: true,
 					showLastUpdateTime: true,
@@ -165,12 +166,43 @@ const config: Config = {
 			title: "",
 			hideOnScroll: true,
 			logo: {
-				alt: "",
+				alt: "CodeRabbit",
 				src: "img/logo/bw_coderabbit.svg",
 				srcDark: "img/logo/white_coderabbit.svg",
 				href: "https://coderabbit.ai",
+				target: "_self",
 			},
-			items: [],
+			items: [
+				// Direct links to main sections
+				{
+					label: "Docs",
+					position: "left",
+					to: "/", // Root of documentation
+					className: "navbar-link-active", // Highlight current section
+				},
+				{
+					href: "https://api.coderabbit.ai/api/swagger/",
+					label: "API Reference",
+					position: "left",
+				},
+				{
+					href: "https://blog.coderabbit.ai/blog",
+					label: "Blog",
+					position: "left",
+				},
+				{
+					href: "https://discord.gg/coderabbit",
+					className: "navbar-icon-link discord-link",
+					"aria-label": "Discord",
+					position: "right",
+				},
+				{
+					href: "https://github.com/coderabbitai",
+					className: "github-link",
+					"aria-label": "GitHub",
+					position: "right",
+				},
+			],
 		},
 		prism: {
 			theme: prismThemes.github,

@@ -16,21 +16,6 @@ const sidebars: SidebarsConfig = {
 			type: "autogenerated",
 			dirName: ".",
 		},
-		{
-			type: "link",
-			label: "API Reference",
-			href: "https://api.coderabbit.ai/api/swagger/",
-		},
-		{
-			type: "link",
-			label: "Blog",
-			href: "https://blog.coderabbit.ai/blog",
-		},
-		{
-			type: "link",
-			label: "Discord",
-			href: "https://discord.gg/GsXnASn26c",
-		},
 	],
 }