Skip to content

Commit 7c8e9f3

Browse files
adding more context so pylon doesnt get confused
1 parent 42a07ca commit 7c8e9f3

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/faq.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,44 @@ import TabItem from '@theme/TabItem';
1010

1111
## General Questions {#general-questions}
1212

13+
### How to trigger a CodeRabbit Review?
14+
15+
Once installed CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repostiory. This branch restriction can be customized in your settings.
16+
17+
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):
18+
19+
- `@coderabbitai review` - Triggers a standard review
20+
- `@coderabbitai full review` - Triggers a comprehensive review
21+
22+
### How to run a review from my IDE?
23+
24+
You can trigger CodeRabbit reviews directly from your IDE using our editor plugins:
25+
26+
- [VS Code Extension](./integrations/vscode.md) - For Visual Studio Code users
27+
- [Cursor Plugin](./integrations/cursor.md) - For Cursor editor users
28+
- [WindSurf Extension](./integrations/windsurf.md) - For WindSurf IDE users
29+
30+
These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions.
31+
32+
### How to install CodeRabbit?
33+
34+
View step by step instructions depending on your platform:
35+
36+
<Tabs>
37+
<TabItem value="github" label="GitHub" default>
38+
See our [GitHub App installation guide](./installation/github.md) for step-by-step instructions.
39+
</TabItem>
40+
<TabItem value="gitlab" label="GitLab">
41+
Follow our [GitLab integration guide](./installation/gitlab.md) to get started.
42+
</TabItem>
43+
<TabItem value="bitbucket" label="Bitbucket">
44+
Check out the [Bitbucket installation steps](./installation/bitbucket.md) for detailed setup.
45+
</TabItem>
46+
<TabItem value="azure" label="Azure DevOps">
47+
View our [Azure DevOps setup guide](./installation/azure.md) for complete installation instructions.
48+
</TabItem>
49+
</Tabs>
50+
1351
### How accurate is CodeRabbit?
1452

1553
> 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:

0 commit comments

Comments
 (0)