Skip to content

Commit 10fb904

Browse files
tyaga001tyaga001
committed
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 <tyaga001@live.com>
1 parent 3d95068 commit 10fb904

20 files changed

+394
-40
lines changed

‎docs/about/_category_.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
label: About
2-
position: 2
1+
label: Plateform
2+
position: 3
33
collapsible: true
4-
collapsed: true
4+
collapsed: false

‎docs/getting-started/_category_.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label: Getting Started
2+
position: 2
3+
collapsible: true
4+
collapsed: false

‎docs/configure-coderabbit.md renamed to ‎docs/getting-started/configure-coderabbit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configure CodeRabbit
3-
sidebar_label: Configure CodeRabbit
3+
sidebar_label: Configure
44
description:
55
CodeRabbit offers various configuration options to tailor the reviews to your
66
specific requirements. Configuration can be made using one of the below

‎docs/getting-started/quickstart.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Playing with CodeRabbit
3+
sidebar_label: Quickstart
4+
description: Get started with CodeRabbit in less than 2 minutes
5+
sidebar_position: 1
6+
---
7+
8+
# Quickstart Guide
9+
10+
:::note
11+
Get started with CodeRabbit in three simple steps. No complex configuration needed.
12+
:::
13+
14+
## Steps to Enable CodeRabbit
15+
16+
1. **Sign In with GitHub**
17+
18+
- Visit [coderabbit.ai](https://coderabbit.ai)
19+
- Click "Sign in with GitHub"
20+
- Authorize CodeRabbit
21+
22+
![Login with GitHub - CodeRabbit](/img/getting-started/login-with-github.png)
23+
24+
2. **Add Your Repository**
25+
26+
- Go to your [Dashboard](https://app.coderabbit.ai/dashboard)
27+
- Click "Add Repositories"
28+
- Select the repositories you want to enable
29+
30+
![CodeRabbit Dashboard](/img/getting-started/coderabbit-dashboard.png)
31+
32+
3. **You're Done 🎉**
33+
34+
- CodeRabbit will automatically start reviewing your Pull Requests
35+
- Default configuration works out of the box
36+
- No additional setup needed
37+
38+
## What's Next?
39+
40+
- Watch CodeRabbit review your next PR automatically
41+
42+
Here's an example of CodeRabbit in action:
43+
44+
![CodeRabbit PR Review Example](/img/getting-started/pr-example.png)
45+
46+
[View live example PR](https://github.com/tyaga001/devtoolsacademy/pull/39)
47+
48+
- [Configure CodeRabbit](/getting-started/configure-coderabbit) (optional)
49+
- [Add custom review instructions](/guides/review-instructions) (optional)
50+
51+
## Need Help?
52+
53+
- Join our [Discord community](https://discord.gg/coderabbit) for support
54+
- Check out our [FAQ](/faq)
55+
- Contact [support@coderabbit.ai](mailto:support@coderabbit.ai)
56+
57+
:::tip
58+
CodeRabbit starts working immediately. You can customize its behavior later when needed.
59+
:::

‎docs/guides/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Guides
22
position: 6
33
collapsible: true
4-
collapsed: true
4+
collapsed: false

‎docs/guides/review-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 3
99
---
1010

1111
The guide explains how to add custom review instructions for the entire project.
12-
Also, see the guide on how to [configure CodeRabbit](../configure-coderabbit.md).
12+
Also, see the guide on how to [configure CodeRabbit](/getting-started/configure-coderabbit).
1313

1414
### Path-based instructions {#path-based}
1515

‎docs/integrations/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Integrations
22
position: 7
33
collapsible: true
4-
collapsed: true
4+
collapsed: false

‎docs/overview/_category_.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label: Overview
2+
position: 1
3+
collapsible: true
4+
collapsed: false

‎docs/introduction.md renamed to ‎docs/overview/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
id: Get Started
3-
title: Get Started
2+
id: introduction
3+
title: Introduction
44
sidebar_label: Introduction
55
sidebar_position: 1
66
description:

‎docs/overview/why-coderabbit.md

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
---
2+
id: why-coderabbit
3+
title: Why CodeRabbit?
4+
sidebar_label: Why CodeRabbit?
5+
sidebar_position: 2
6+
description: CodeRabbit is AI-powered code reviews built for modern development teams
7+
---
8+
9+
# Why CodeRabbit?
10+
11+
Looking back at CodeRabbit's journey, our fundamental mission remains unchanged:
12+
13+
> To build the best code review experience in the cloud
14+
15+
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.
16+
17+
## Real-World Code Reviews
18+
19+
> 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.
20+
21+
:::tip See it in action
22+
Browse through real-world examples of CodeRabbit's reviews on GitHub to see how it helps developers write better code every day.
23+
:::
24+
25+
## The Problem With Traditional Code Reviews
26+
27+
As engineering teams scale, several critical issues emerge:
28+
29+
1. **Review Latency** - PRs often sit for days waiting for review, blocking feature delivery
30+
2. **Inconsistent Quality** - Different code reviewers focus on different aspects
31+
3. **Knowledge Silos** - Critical insights stay trapped with individual code reviewers
32+
4. **Context Switching** - Developers lose focus when reviewing large PRs
33+
5. **Scale Limitations** - Senior developers become review bottlenecks
34+
35+
## CodeRabbit is AI-Powered
36+
37+
CodeRabbit leverages advanced AI to provide intelligent, context-aware code reviews.
38+
39+
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:
40+
41+
- Security vulnerabilities
42+
- Performance optimizations
43+
- Design patterns
44+
- Best practices
45+
- Documentation completeness
46+
47+
:::tip Did you know?
48+
CodeRabbit's AI model is trained on millions of code reviews and continuously learns from user feedback to improve its suggestions.
49+
:::
50+
51+
## CodeRabbit is Context-Aware
52+
53+
A review system that understands your codebase and team preferences.
54+
55+
Unlike traditional automated review tools that apply generic rules, CodeRabbit:
56+
57+
- Learns from your team's coding patterns
58+
- Understands your project's architecture
59+
- Considers the full context of changes
60+
- Adapts to your team's preferences
61+
- Provides relevant, actionable feedback
62+
63+
## CodeRabbit is Fully Managed
64+
65+
Leave the infrastructure management to us.
66+
67+
Being fully managed means CodeRabbit:
68+
69+
- Automatically scales with your needs
70+
- Requires zero maintenance
71+
- Provides enterprise-grade security
72+
- Ensures high availability
73+
- Handles updates seamlessly
74+
75+
## CodeRabbit is Platform Agnostic
76+
77+
Supporting all major Git platforms and development workflows.
78+
79+
CodeRabbit integrates seamlessly with:
80+
81+
- GitHub
82+
- GitLab
83+
- Azure DevOps
84+
85+
And supports all major programming languages and frameworks without requiring any special configuration.
86+
87+
## Who should use CodeRabbit?
88+
89+
### Individual Developers
90+
91+
- Get expert-level code reviews instantly
92+
- Learn best practices through AI suggestions
93+
- Improve code quality before team review
94+
95+
### Development Teams
96+
97+
- Standardize review processes
98+
- Reduce review bottlenecks
99+
- Share knowledge across the team
100+
- Maintain consistent code quality
101+
102+
### Enterprises
103+
104+
- Scale code review processes efficiently
105+
- Enforce security and compliance standards
106+
- Reduce technical debt
107+
- Accelerate development cycles
108+
109+
:::tip Free for Open Source
110+
CodeRabbit is completely **FREE** for open-source projects. Our architecture enables us to provide a sustainable free tier that includes:
111+
112+
- Unlimited public repositories
113+
- Full feature access
114+
- No credit card required
115+
:::
116+
117+
## CodeRabbit Doesn't Lock You In
118+
119+
Built on open standards, easy to integrate and customize.
120+
121+
CodeRabbit:
122+
123+
- Works with your existing Git workflow
124+
- Requires minimal configuration
125+
- Supports standard code review protocols
126+
- Allows easy export of review data
127+
- Integrates with popular development tools
128+
129+
## CodeRabbit Makes Code Reviews Easy
130+
131+
Set up automated code reviews in minutes.
132+
133+
1. Log in with GitHub, GitLab, or Azure DevOps
134+
2. Select repositories to review
135+
3. Create a pull request
136+
4. Watch CodeRabbit provide instant feedback
137+
138+
```bash
139+
# Example review feedback time
140+
Traditional Review: 24-48 hours
141+
CodeRabbit Review: < 5 minutes
142+
```
143+
144+
## Data Privacy and Security
145+
146+
Your code's security is our top priority.
147+
148+
- **SOC2 Type II Certified**
149+
- **GDPR Compliant**
150+
- **Zero Data Retention**: Reviews are ephemeral
151+
- **Isolated Environments**: Your code stays private
152+
- **No Training**: Your code is never used to train models
153+
154+
## Are you ready?
155+
156+
Join thousands of developers who are already benefiting from AI-powered code reviews.
157+
158+
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.
159+
160+
<div style={{display: 'flex', gap: '10px', marginTop: '20px'}}>
161+
<a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Sign Up Free</a>
162+
<a href="https://discord.gg/coderabbit" className="button button--secondary button--lg">Join Discord</a>
163+
</div>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy