Skip to content

Commit f55f85c

Browse files
committed
docs: restructure sidebar with improved navigation
- Improve navigation hierarchy and structure - Update sidebar styling - Implement collapsible sections - Add hover states and active indicators
1 parent 10fb904 commit f55f85c

File tree

13 files changed

+97
-141
lines changed

13 files changed

+97
-141
lines changed

docs/about/_category_.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
label: Plateform
2-
position: 3
1+
label: Platform
2+
position: 8
33
collapsible: true
44
collapsed: false

docs/about/support.md

+1-1
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

+78-4
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ Switch between organizations easily:
8080
-**Older PRs**: Use `@coderabbitai review` to trigger manually
8181

8282
:::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.
83+
Just created a PR right before installing CodeRabbit? Drop a `@coderabbitai full review` comment in old PR to get it reviewed.
8484
:::
8585

8686
![CodeRabbit- Full-Review](/img/faq/full-review.png)
8787

8888
### Customization Options
8989

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

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

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

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

docs/getting-started/quickstart.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Get started with CodeRabbit in three simple steps. No complex configuration need
1919
- Click "Sign in with GitHub"
2020
- Authorize CodeRabbit
2121

22-
![Login with GitHub - CodeRabbit](/img/getting-started/login-with-github.png)
22+
![CodeRabbit Login](/img/integrations/login-self-hosted-github.png)
2323

2424
2. **Add Your Repository**
2525

2626
- Go to your [Dashboard](https://app.coderabbit.ai/dashboard)
2727
- Click "Add Repositories"
2828
- Select the repositories you want to enable
2929

30-
![CodeRabbit Dashboard](/img/getting-started/coderabbit-dashboard.png)
30+
![CodeRabbit Dashboard](/img/getting-started/dashboard-coderabbit.png)
3131

3232
3. **You're Done 🎉**
3333

@@ -41,7 +41,7 @@ Get started with CodeRabbit in three simple steps. No complex configuration need
4141

4242
Here's an example of CodeRabbit in action:
4343

44-
![CodeRabbit PR Review Example](/img/getting-started/pr-example.png)
44+
![CodeRabbit PR Review Example](/img/getting-started/pr-examples.png)
4545

4646
[View live example PR](https://github.com/tyaga001/devtoolsacademy/pull/39)
4747

docs/guides/_category_.yml

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

docs/guides/delete-account.md

-117
This file was deleted.

docs/platforms/_category_.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
label: Supported Git Platforms
2-
position: 4
1+
label: Git
2+
position: 3
33
collapsible: true
44
collapsed: false

docs/self-hosted/_category_.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
label: Self-Hosted CodeRabbit
2-
position: 8
1+
label: Self-Hosted
2+
position: 4
33
collapsible: true
44
collapsed: false

docs/tools/_category_.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Supported Tools
2-
position: 5
2+
position: 6
33
collapsible: true
44
collapsed: true

docusaurus.config.ts

+2-8
Original file line numberDiff line numberDiff line change
@@ -173,17 +173,11 @@ const config: Config = {
173173
target: "_self",
174174
},
175175
items: [
176-
// Direct links to main sections
177176
{
178177
label: "Docs",
179178
position: "left",
180-
to: "/", // Root of documentation
181-
className: "navbar-link-active", // Highlight current section
182-
},
183-
{
184-
href: "https://api.coderabbit.ai/api/swagger/",
185-
label: "API Reference",
186-
position: "left",
179+
to: "/",
180+
className: "navbar-link-active",
187181
},
188182
{
189183
href: "https://blog.coderabbit.ai/blog",

sidebars.ts

+5
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ const sidebars: SidebarsConfig = {
1616
type: "autogenerated",
1717
dirName: ".",
1818
},
19+
{
20+
type: "link",
21+
label: "API Reference",
22+
href: "https://api.coderabbit.ai/api/swagger/",
23+
},
1924
],
2025
}
2126

Loading
277 KB
Loading

0 commit comments

Comments
 (0)