Skip to content

Commit

Permalink
docs: enhance FAQ page and fix linting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
tyaga001 authored and NatoBoram committed Nov 18, 2024
1 parent 90844c2 commit ba64f86
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: FAQs
description: Frequently asked questions about CodeRabbit.
sidebar_position: 9
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -45,6 +46,7 @@ CodeRabbit works with all programming languages, with varying proficiency based
### Organization Management

Switch between organizations easily:

1. Click organization name (top-left corner)
2. Select desired organization
3. Access organization-specific settings
Expand All @@ -57,11 +59,13 @@ Switch between organizations easily:
> Code reviews remain essential, whether the code is written by a human or a bot. This is mainly because the perspective of the reviewer differs from that of the code generator, whether human or machine. This distinction is precisely why human peer reviews have been effective for so long. While AI-powered code-generation tools like GitHub Copilot hold immense potential, it's important to recognize that these generators are still in their early stages and may not be equipped to auto-generate meaningful code for moderately complex applications.
#### vs AI Code Generators

- Provides review perspective different from code generation
- Complements tools like GitHub Copilot
- Focuses on code quality and best practices

#### vs Traditional Review Tools

- Context-aware feedback
- Actionable suggestions
- Direct commit capabilities
Expand Down Expand Up @@ -96,6 +100,7 @@ Just created a PR right before installing CodeRabbit? or drop a `@coderabbitai f
### Interaction Guide

Interact with CodeRabbit by:

1. Replying directly to CodeRabbit comments
2. Tagging `@coderabbitai` in PR discussions
3. Adding review comments for specific lines
Expand All @@ -107,11 +112,11 @@ When team members are active in PRs, use `@coderabbitai` to engage the bot.

### Usage Limits

| Feature | Free/Trial | Pro Plan |
|---------|------------|----------|
| Files per hour | 200 | 200 |
| Reviews | 3 back-to-back, then 3/hour | Higher limits |
| Conversations | 25 back-to-back, then 50/hour | Higher limits |
| Feature | Free/Trial | Pro Plan |
| -------------- | ----------------------------- | ------------- |
| Files per hour | 200 | 200 |
| Reviews | 3 back-to-back, then 3/hour | Higher limits |
| Conversations | 25 back-to-back, then 50/hour | Higher limits |

:::note
In-trial and open-source plans have lower rate limits than the paid plan. In all cases, we re-allow further reviews/conversations after a brief timeout.
Expand All @@ -120,16 +125,17 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all
## Integration Guide {#integration-guide}

### Prerequisites

- Organization admin access
- Domain allowlist (GitLab: add `coderabbit.ai`)
- Default branch configuration

### Quick Setup

1. Sign up at [coderabbit.ai](https://coderabbit.ai) using your GitHub account
2. Add your repository through the dashboard
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).
:::

0 comments on commit ba64f86

Please sign in to comment.