Skip to content

Commit e35ab81

Browse files
tyaga001tyaga001
authored
refactor(docs): reorganize navigation structure (#155)
* 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> * docs: restructure sidebar with improved navigation - Improve navigation hierarchy and structure - Update sidebar styling - Implement collapsible sections - Add hover states and active indicators * fix(docs): resolve markdown linting errors in quickstart guide * docs: remove redundant tip from FAQ * docs: remove redundant tip from FAQ * docs: removed extra parenthesis * docs: removed extra space * docs: removed extra space * docs: simplify getting started list structure * docs: simplify getting started list structure --------- Signed-off-by: Ankur Tyagi <tyaga001@live.com>
1 parent 3d95068 commit e35ab81

25 files changed

+466
-164
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: Platform
2+
position: 8
33
collapsible: true
4-
collapsed: true
4+
collapsed: false

‎docs/about/support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Regardless of the method or location through which CodeRabbit provides Support,
4444
:::tip
4545

4646
To see more common issues faced by CodeRabbit users, visit our
47-
[FAQ section](../faq.md) for detailed answers and solutions to frequently
47+
[FAQ section](/faq) for detailed answers and solutions to frequently
4848
encountered problems.
4949

5050
:::

‎docs/faq.md

Lines changed: 77 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,12 @@ Switch between organizations easily:
7979
- ✅ **New Commits**: Automatic review when pushed to any PR
8080
- ⚡ **Older PRs**: Use `@coderabbitai review` to trigger manually
8181

82-
:::tip Pro Tip
83-
Just created a PR right before installing CodeRabbit? or drop a `@coderabbitai full review` comment in old PR to get it reviewed.
84-
:::
85-
8682
![CodeRabbit- Full-Review](/img/faq/full-review.png)
8783

8884
### Customization Options
8985

9086
- **Language Settings**: Configure review language in repository settings
91-
- **Review Rules**: Customize via [Review Instructions](./guides/review-instructions.md)
87+
- **Review Rules**: Customize via [Review Instructions](/guides/review-instructions)
9288
- **Branch Selection**: Default branch reviews enabled by default (configurable)
9389

9490
### Access & Permissions
@@ -104,7 +100,7 @@ Interact with CodeRabbit by:
104100
1. Replying directly to CodeRabbit comments
105101
2. Tagging `@coderabbitai` in PR discussions
106102
3. Adding review comments for specific lines
107-
4. Customize via [Review Instructions](./guides/review-instructions.md)
103+
4. Customize via [Review Instructions](/guides/review-instructions)
108104

109105
:::tip Collaboration Mode
110106
When team members are active in PRs, use `@coderabbitai` to engage the bot.
@@ -137,5 +133,79 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all
137133
3. That's it. CodeRabbit will automatically start reviewing your PRs
138134

139135
:::tip Need Help?
140-
Visit our [Support](./about/support.md) page for additional assistance or reach out to our team on [discord](http://discord.gg/coderabbit).
136+
Visit our [Support](/about/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
141137
:::
138+
139+
## Account Management {#account-management}
140+
141+
### How do I delete my CodeRabbit account?
142+
143+
:::danger Irreversible Account Deletion
144+
Deleting your CodeRabbit account is permanent and cannot be undone. This action will permanently erase:
145+
146+
- Organization and Repository data
147+
- AI Bot learnings and insights
148+
- Subscriptions and billing information
149+
- All settings and configurations
150+
- Reports and recurring reports
151+
- Third-party service integrations
152+
:::
153+
154+
<Tabs>
155+
<TabItem value="deletion" label="Account Deletion Steps" default>
156+
1. Sign into your CodeRabbit account
157+
2. Navigate to the **Subscription** page
158+
3. Click the orange **Delete Account** button
159+
4. Review the deletion confirmation modal
160+
5. Type "delete" to confirm
161+
6. Complete platform-specific cleanup steps below
162+
163+
:::info
164+
The Delete Account button is only visible to admin users.
165+
:::
166+
167+
A confirmation modal will appear explaining the consequences of account deletion. You can expand each section for detailed information:
168+
169+
<div align="center">
170+
![Delete Account](/img/guides/delete_account_light.png#gh-light-mode-only)
171+
![Delete Account](/img/guides/delete_account_dark.png#gh-dark-mode-only)
172+
</div>
173+
174+
</TabItem>
175+
<TabItem value="github" label="GitHub Cleanup">
176+
After account deletion, you must:
177+
178+
**Remove OAuth App:**
179+
1. Go to Organization settings
180+
2. Click **OAuth Application Policy**
181+
3. Find **coderabbitai** and click the pencil icon
182+
4. Click **Revoke**
183+
184+
**Uninstall GitHub App:**
185+
1. Go to Organization settings
186+
2. Click **GitHub Apps**
187+
3. Select **Configure**
188+
4. Click **Uninstall**
189+
190+
</TabItem>
191+
<TabItem value="gitlab" label="GitLab Cleanup">
192+
Complete these steps:
193+
194+
1. Remove OAuth App from User Settings > Applications
195+
2. Remove Webhook from Group > Project Settings > Webhooks
196+
3. Remove Bot User from Group > Manage > Members
197+
198+
</TabItem>
199+
<TabItem value="azure" label="Azure DevOps Cleanup">
200+
1. Go to Project Settings > Service Hooks
201+
2. Delete CodeRabbit webhooks
202+
3. Remove CodeRabbit user or delete associated Personal Access Token
203+
</TabItem>
204+
</Tabs>
205+
206+
:::warning Post-Deletion Steps
207+
The platform-specific cleanup steps are necessary to completely remove CodeRabbit access. Without completing these steps:
208+
209+
- CodeRabbit may retain some platform permissions
210+
- Signing back in will recreate minimal account data
211+
:::

‎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: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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+
### Sign In with GitHub
17+
18+
- Visit [coderabbit.ai](https://coderabbit.ai)
19+
- Click "Sign in with GitHub"
20+
- Authorize CodeRabbit
21+
22+
![CodeRabbit Login](/img/integrations/login-self-hosted-github.png)
23+
24+
### 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/dashboard-coderabbit.png)
31+
32+
### 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
41+
- Here's an example of CodeRabbit in action:
42+
![CodeRabbit PR Review Example](/img/getting-started/pr-examples.png)
43+
- [View live example PR](https://github.com/tyaga001/devtoolsacademy/pull/39)
44+
- [Configure CodeRabbit](/getting-started/configure-coderabbit) (optional)
45+
- [Add custom review instructions](/guides/review-instructions) (optional)
46+
47+
## Need Help?
48+
49+
- Join our [Discord community](https://discord.gg/coderabbit) for support
50+
- Check out our [FAQ](/faq)
51+
- Contact [support@coderabbit.ai](mailto:support@coderabbit.ai)
52+
53+
:::tip
54+
CodeRabbit starts working immediately. You can customize its behavior later when needed.
55+
:::

‎docs/guides/_category_.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Guides
2-
position: 6
2+
position: 5
33
collapsible: true
4-
collapsed: true
4+
collapsed: false

‎docs/guides/delete-account.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

‎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

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