Skip to content

Commit 9e7d829

Browse files
committed
Update FAQ documentation
1 parent b0e0536 commit 9e7d829

File tree

1 file changed

+42
-36
lines changed

1 file changed

+42
-36
lines changed

docs/faq/faq.md

+42-36
Original file line numberDiff line numberDiff line change
@@ -4,111 +4,111 @@ sidebar_label: FAQs
44
description: Frequently asked questions about CodeRabbit.
55
---
66

7-
## General
7+
### General
88

9-
### How accurate is CodeRabbit's review?
9+
#### How accurate is CodeRabbit's review?
1010

1111
Early adoption results for CodeRabbit have been highly promising, demonstrating
1212
significant accuracy in code reviews. However, it's crucial to understand that
1313
AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our
1414
technology is continuously improving, aiming for the highest possible accuracy
1515
in reviews.
1616

17-
### Which programming languages does CodeRabbit support?
17+
#### Which programming languages does CodeRabbit support?
1818

19-
CodeRabbit is designed to work with all programming languages. However, the
19+
CodeRabbit is designed to work with all programming languages. The
2020
proficiency of our AI models might vary between languages based on their
2121
popularity and the public availability of training data.
2222

23-
### Does CodeRabbit store my code?
23+
#### Does CodeRabbit store my code?
2424

25-
We do not store your code. The code collected at the time of the review is
25+
We do not store your code. The code repository that is cloned at the time of the review is
2626
disposed of as soon as the review is complete. During the review, there is
2727
complete data isolation of the code being reviewed, and no one from CodeRabbit
2828
or outside has access to the code.
2929

30-
### Does CodeRabbit use my proprietary code for training language models?
30+
#### Does CodeRabbit use my proprietary code for training language models?
3131

3232
We train our system only using publicly available datasets. CodeRabbit never
3333
uses proprietary code from private repositories for training purposes.
3434

35-
### Can I switch between different organizations on CodeRabbit?
35+
#### Can I switch between different organizations on CodeRabbit?
3636

3737
Yes, you can switch between different organizations on CodeRabbit. To do so,
3838
click on the organization name in the top-left corner of the CodeRabbit UI.
3939

4040
![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
4141
![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)
4242

43-
### Can a CodeRabbit subscription be used across multiple organizations?
43+
#### What Large Language Models does CodeRabbit use?
4444

45-
Subscription seats are tied to the specific GitHub/GitLab organization under
46-
which they are purchased and cannot be used under another organization.
45+
CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
46+
researching and testing upcoming LLMs to ensure we're offering the most precise
47+
reviews possible.
4748

48-
### Can CodeRabbit review my existing PRs after integrating it?
49+
### Subscription
4950

50-
CodeRabbit will by default only review new PRs or existing PRs which have a new
51-
commit after the app is installed. You can, however, use the
52-
`@coderabbitai review` command on the PR to trigger a review for existing PRs.
51+
#### Can a CodeRabbit subscription be used across multiple organizations?
5352

54-
### Who can install CodeRabbit on the repositories?
55-
56-
You need to be a GitHub/GitLab admin to add the repositories.
53+
Subscription seats are tied to the specific GitHub/GitLab organization under
54+
which they are purchased and cannot be used under another organization.
5755

58-
### Do I need my own OpenAI key with CodeRabbit Pro?
56+
#### Do I need my own OpenAI key with CodeRabbit Pro?
5957

6058
OpenAI cost is included as part of the subscription. You don't need to have your
6159
own OpenAI key.
6260

63-
### What Large Language Models does CodeRabbit use?
61+
#### How can I add or remove users for my subscription?
6462

65-
CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
66-
researching and testing upcoming LLMs to ensure we're offering the most precise
67-
reviews possible.
63+
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
64+
or remove users as needed.
65+
66+
### Usage and Configuration
67+
68+
#### Can CodeRabbit review my existing PRs after integrating it?
69+
70+
CodeRabbit will by default only review new PRs or existing PRs which have a new
71+
commit after the app is installed. You can, however, use the
72+
`@coderabbitai review` command on the PR to trigger a review for existing PRs.
6873

69-
### Can I customize CodeRabbit?
74+
#### Can I customize CodeRabbit?
7075

7176
Reviews are customizable. For information, check out our
7277
[Customization](../guides/review-instructions.md) guide.
7378

74-
### Can I choose a language other than English for the reviews?
79+
#### Can I choose a language other than English for the reviews?
7580

7681
CodeRabbit supports most widely used languages. You can configure this in the
7782
repository settings.
7883

79-
### What access does CodeRabbit need to my repositories?
84+
#### What access does CodeRabbit need to my repositories?
8085

8186
CodeRabbit requests minimal access to perform code reviews and post comments on
8287
Pull Requests. On GitHub, it requires read access to metadata, code,
8388
discussions, and issues, as well as read/write access to pull requests. On
8489
GitLab, it requires read access to the repository, and the CodeRabbit Bot user
8590
requires a developer role.
8691

87-
### How can I add or remove users for my subscription?
88-
89-
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
90-
or remove users as needed.
91-
92-
### How can I interact with the CodeRabbit bot?
92+
#### How can I interact with the CodeRabbit bot?
9393

9494
To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are
9595
team members collaborating on pull requests, the bot stays silent by default but
9696
can be engaged by tagging **@coderabbitai**. This feature allows you to provide
9797
context, generate test cases, or ask for specific code suggestions, all within
9898
the context of your code lines or entire files.
9999

100-
### Can individual developers use CodeRabbit?
100+
#### Can individual developers use CodeRabbit?
101101

102102
Absolutely! Whether you're an individual developer or part of an organization,
103103
CodeRabbit can be your coding assistant, providing you with invaluable
104104
suggestions.
105105

106-
### Which branches are the pull requests reviewed on?
106+
#### Which branches are the pull requests reviewed on?
107107

108108
CodeRabbit reviews pull requests on the default branch by default. You can
109109
change this in the repository settings.
110110

111-
### CodeRabbit Usage Limits
111+
#### CodeRabbit Usage Limits
112112

113113
There are hourly rate limits for each developer per repository:
114114

@@ -119,7 +119,13 @@ There are hourly rate limits for each developer per repository:
119119
In-trial and open-source plans have lower rate limits than the paid plan. In all
120120
cases, we re-allow further reviews/conversations after a brief timeout.
121121

122-
### I can't add CodeRabbit to my GitLab Repositories. What should I do?
122+
### Integration
123+
124+
#### Who can install CodeRabbit on the repositories?
125+
126+
You need to be an admin of the orgnizaation to add the repositories.
127+
128+
#### I can't add CodeRabbit to my GitLab Repositories. What should I do?
123129

124130
If there are any access restrictions by domain, then you will need to add
125131
`coderabbit.ai` as an allowed domain.

0 commit comments

Comments
 (0)