Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

refactor(docs): reorganize navigation structure #155

Merged
merged 10 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
6 changes: 3 additions & 3 deletions docs/about/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: About
position: 2
label: Platform
position: 8
collapsible: true
collapsed: true
collapsed: false
2 changes: 1 addition & 1 deletion docs/about/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Regardless of the method or location through which CodeRabbit provides Support,
:::tip

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

:::
84 changes: 77 additions & 7 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,16 +79,12 @@ Switch between organizations easily:
- ✅ **New Commits**: Automatic review when pushed to any PR
- ⚡ **Older PRs**: Use `@coderabbitai review` to trigger manually

:::tip Pro Tip
Just created a PR right before installing CodeRabbit? or drop a `@coderabbitai full review` comment in old PR to get it reviewed.
:::

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

### Customization Options

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

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

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

:::tip Need Help?
Visit our [Support](./about/support.md) page for additional assistance or reach out to our team on [discord](http://discord.gg/coderabbit).
Visit our [Support](/about/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
:::

## Account Management {#account-management}

### How do I delete my CodeRabbit account?

:::danger Irreversible Account Deletion
Deleting your CodeRabbit account is permanent and cannot be undone. This action will permanently erase:

- Organization and Repository data
- AI Bot learnings and insights
- Subscriptions and billing information
- All settings and configurations
- Reports and recurring reports
- Third-party service integrations
:::

<Tabs>
<TabItem value="deletion" label="Account Deletion Steps" default>
1. Sign into your CodeRabbit account
2. Navigate to the **Subscription** page
3. Click the orange **Delete Account** button
4. Review the deletion confirmation modal
5. Type "delete" to confirm
6. Complete platform-specific cleanup steps below

:::info
The Delete Account button is only visible to admin users.
:::

A confirmation modal will appear explaining the consequences of account deletion. You can expand each section for detailed information:

<div align="center">
![Delete Account](/img/guides/delete_account_light.png#gh-light-mode-only)
![Delete Account](/img/guides/delete_account_dark.png#gh-dark-mode-only)
</div>

</TabItem>
<TabItem value="github" label="GitHub Cleanup">
After account deletion, you must:

**Remove OAuth App:**
1. Go to Organization settings
2. Click **OAuth Application Policy**
3. Find **coderabbitai** and click the pencil icon
4. Click **Revoke**

**Uninstall GitHub App:**
1. Go to Organization settings
2. Click **GitHub Apps**
3. Select **Configure**
4. Click **Uninstall**

</TabItem>
<TabItem value="gitlab" label="GitLab Cleanup">
Complete these steps:

1. Remove OAuth App from User Settings > Applications
2. Remove Webhook from Group > Project Settings > Webhooks
3. Remove Bot User from Group > Manage > Members

</TabItem>
<TabItem value="azure" label="Azure DevOps Cleanup">
1. Go to Project Settings > Service Hooks
2. Delete CodeRabbit webhooks
3. Remove CodeRabbit user or delete associated Personal Access Token
</TabItem>
</Tabs>

:::warning Post-Deletion Steps
The platform-specific cleanup steps are necessary to completely remove CodeRabbit access. Without completing these steps:

- CodeRabbit may retain some platform permissions
- Signing back in will recreate minimal account data
:::
4 changes: 4 additions & 0 deletions docs/getting-started/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
label: Getting Started
position: 2
collapsible: true
collapsed: false
Original file line number Diff line number Diff line change
@@ -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
Expand Down
59 changes: 59 additions & 0 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
@@ -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

### Sign In with GitHub

- Visit [coderabbit.ai](https://coderabbit.ai)
- Click "Sign in with GitHub"
- Authorize CodeRabbit

![CodeRabbit Login](/img/integrations/login-self-hosted-github.png)

### 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/dashboard-coderabbit.png)

### 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-examples.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.
:::
4 changes: 2 additions & 2 deletions docs/guides/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: Guides
position: 6
position: 5
collapsible: true
collapsed: true
collapsed: false
117 changes: 0 additions & 117 deletions docs/guides/delete-account.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/guides/review-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: Integrations
position: 7
collapsible: true
collapsed: true
collapsed: false
4 changes: 4 additions & 0 deletions docs/overview/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
label: Overview
position: 1
collapsible: true
collapsed: false
4 changes: 2 additions & 2 deletions docs/introduction.md → docs/overview/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Get Started
title: Get Started
id: introduction
title: Introduction
sidebar_label: Introduction
sidebar_position: 1
description:
Expand Down
Loading
Loading