Skip to content

Fix/faq pylon #370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 31, 2025
Merged

Fix/faq pylon #370

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7c8e9f3
adding more context so pylon doesnt get confused
alexcoderabbitai May 31, 2025
e951966
more fixes
alexcoderabbitai May 31, 2025
2c1b6be
add notes on reporting vs reviewing
alexcoderabbitai May 31, 2025
fc5056a
fix link
alexcoderabbitai May 31, 2025
3a386a9
fix more links
alexcoderabbitai May 31, 2025
ecd10fb
fix more links
alexcoderabbitai May 31, 2025
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
38 changes: 38 additions & 0 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,44 @@ import TabItem from '@theme/TabItem';

## General Questions {#general-questions}

### How to trigger a CodeRabbit Review?

Once installed, CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repository. We automatically detect the name of the primary branch (whether this be master, main, dev, etc). This branch restriction can be customized in your settings.

You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](./commands.md) for full list):

- `@coderabbitai review` - Triggers a standard review
- `@coderabbitai full review` - Triggers a comprehensive review

### How to run a review from my IDE?

You can trigger CodeRabbit reviews directly from your IDE using our editor plugins:

- [VS Code Extension](./integrations/vscode.md) - For Visual Studio Code users
- [Cursor Plugin](./integrations/cursor.md) - For Cursor editor users
- [WindSurf Extension](./integrations/windsurf.md) - For WindSurf IDE users

These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions.

### How to install CodeRabbit?

View step by step instructions depending on your platform:

<Tabs>
<TabItem value="github" label="GitHub" default>
See our [GitHub App installation guide](./installation/github.md) for step-by-step instructions.
</TabItem>
<TabItem value="gitlab" label="GitLab">
Follow our [GitLab integration guide](./installation/gitlab.md) to get started.
</TabItem>
<TabItem value="bitbucket" label="Bitbucket">
Check out the [Bitbucket installation steps](./installation/bitbucket.md) for detailed setup.
</TabItem>
<TabItem value="azure" label="Azure DevOps">
View our [Azure DevOps setup guide](./installation/azure.md) for complete installation instructions.
</TabItem>
</Tabs>

### How accurate is CodeRabbit?

> CodeRabbit demonstrates high accuracy in code reviews based on early adoption results. While 100% accuracy isn't guaranteed due to AI's evolving nature, our technology continuously improves through:
Expand Down
Loading