Skip to content

Commit 69701dd

Browse files
harjotgillguritfaqcoderabbitai[bot]
authored andcommitted
doc fixes (#33)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Gur singh <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 4f6b57b commit 69701dd

29 files changed

+112
-648
lines changed

docs/faq/faq.md

+59-35
Original file line numberDiff line numberDiff line change
@@ -4,81 +4,109 @@ sidebar_label: FAQs
44
description: Frequently asked questions about CodeRabbit.
55
---
66

7-
#### **1. How accurate is CodeRabbit's review?**
7+
#### How accurate is CodeRabbit's review?
88

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

15-
#### **2. Which programming languages does CodeRabbit support?**
15+
#### Which programming languages does CodeRabbit support?
1616

1717
CodeRabbit is designed to work with all programming languages. However, the
18-
proficiency of our AI models might vary between languages, which could slightly
19-
affect the accuracy of the review.
18+
proficiency of our AI models might vary between languages based on their
19+
popularity and the public availability of training data.
2020

21-
#### **3. Does CodeRabbit store my code ?**
21+
#### Does CodeRabbit store my code?
2222

23-
We do not store any source code. The code collected at the time of the review is disposed of as soon as the review is complete. During the review, there is complete data isolation for the code being reviewed, and no one from CodeRabbit or outside has access to the code.
23+
We do not store your code. The code collected at the time of the review is
24+
disposed off as soon as the review is complete. During the review, there is
25+
complete data isolation of the code being reviewed, and no one from CodeRabbit
26+
or outside has access to the code.
2427

25-
#### **4. Does CodeRabbit use my proprietary code for training language models?**
28+
#### Does CodeRabbit use my proprietary code for training language models?
2629

27-
We train our system only using open source projects. CodeRabbit never uses the proprietary
28-
code on private repositories for training purposes.
30+
We train our system only using publicly available datasets. CodeRabbit never
31+
uses the proprietary code from private repositories for training purposes.
2932

30-
#### **5. What Large Language Models does CodeRabbit use?**
33+
#### Can I switch between different organizations on CodeRabbit?
34+
35+
Yes, you can switch between different organizations on CodeRabbit. To do so,
36+
click on the organization name in the top-right corner of the CodeRabbit UI.
37+
38+
![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
39+
![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)
40+
41+
#### Can CodeRabbit subscription be used across multiple organizations?
42+
43+
Subscription seats are tied to the specific GitHub/GitLab organization under
44+
which they are purchased and cannot be used under another organization.
45+
46+
#### Can CodeRabbit review my existing PRs after integrating it?
47+
48+
CodeRabbit would by default only review new PRs or existing PRs which have a new
49+
commit after the app is installed. You can, however, use the
50+
`@coderabbitai review` command on the PR to trigger a review of existing PRs.
51+
52+
#### Who can add the repositories on CodeRabbit?
53+
54+
You need to be a GitHub/GitLab admin to add the repositories.
55+
56+
#### Do I need my own OpenAI key with CodeRabbit Pro?
57+
58+
OpenAI cost is included as part of the subscription. You don't need to have your
59+
own OpenAI key.
60+
61+
#### What Large Language Models does CodeRabbit use?
3162

3263
CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
3364
researching and testing upcoming LLMs to ensure we're offering the most precise
3465
reviews possible.
3566

36-
#### **6. Can I customize CodeRabbit?**
67+
#### Can I customize CodeRabbit?
3768

3869
Reviews are customizable. For information, check out our
39-
[Get Started page](../get-started/signup.md).
70+
[Customization](../guides/review-instructions.md) guide.
4071

41-
#### **7. Can I choose a language other than English for the reviews?**
72+
#### Can I choose a language other than English for the reviews?
4273

4374
CodeRabbit supports most widely used languages. You can configure this in the
4475
repository settings.
4576

46-
#### **8. What access does CodeRabbit need to my repositories?**
77+
#### What access does CodeRabbit need to my repositories?
4778

4879
CodeRabbit requests minimal access to perform code reviews and post comments on
4980
Pull Requests. On GitHub, it requires read access to metadata, code,
5081
discussions, issues, and read/write access to the pull requests. On GitLab, it
5182
requires read access to the repository, and the CodeRabbit Bot user requires a
5283
developer role.
5384

54-
#### **9. How can I add or remove users for my subscription?**
85+
#### How can I add or remove users for my subscription?
5586

5687
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
5788
or remove users as needed.
5889

59-
#### **10. How can I interact with the CodeRabbit bot?**
90+
#### How can I interact with the CodeRabbit bot?
6091

6192
To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are
6293
team members collaborating on pull requests, the bot stays silent by default but
63-
can be engaged by tagging **@Coderabbitai**. This feature allows you to provide
94+
can be engaged by tagging **@coderabbitai**. This feature allows you to provide
6495
context, generate test cases, or ask for specific code suggestions, all within
6596
the context of your code lines or entire files.
6697

67-
#### **11. Can individual developers use CodeRabbit?**
98+
#### Can individual developers use CodeRabbit?
6899

69100
Absolutely! Whether you're an individual developer or part of an organization,
70101
CodeRabbit can be your coding assistant, providing you with invaluable
71102
suggestions.
72103

73-
#### **12. Which branches are the pull requests reviewed on?**
104+
#### Which branches are the pull requests reviewed on?
74105

75-
CodeRabbit reviews pull requests on the default branch.
106+
CodeRabbit reviews pull requests on the default branch by default. You can
107+
change this in the repository settings.
76108

77-
#### **13. Is it possible for CodeRabbit to include additional branches for review?**
78-
79-
Yes, you can change it under the repository settings.
80-
81-
#### **14. CodeRabbit Usage Limits**
109+
#### CodeRabbit Usage Limits
82110

83111
There are hourly rate limits for each developer per repository:
84112

@@ -89,18 +117,14 @@ There are hourly rate limits for each developer per repository:
89117
In-trial and open-source plans have lower rate limits than the paid plan. In all
90118
cases, we re-allow further reviews/conversations after a brief timeout.
91119

92-
#### **15. I can't add CodeRabbit to my GitLab Repositories?**
120+
#### I can't add CodeRabbit to my GitLab Repositories. What should I do?
93121

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

97-
:::note
125+
:::tip
98126

99-
We are continually innovating and enhancing our application with new
100-
capabilities. Stay tuned and follow us for updates as new exciting features are
101-
built. We're committed to making your experience with CodeRabbit even better.
127+
If you have further questions or need additional information, please check out
128+
our [Support](../about/support.md) page for more details.
102129

103130
:::
104-
105-
If you have further questions or need additional information, don't hesitate to
106-
reach out to us at [[email protected]](mailto:[email protected]).

docs/get-started/add-repo.md

-39
This file was deleted.

docs/get-started/analytics.md

-35
This file was deleted.

docs/get-started/images/add2.png

-51.4 KB
Binary file not shown.

docs/get-started/images/add3.png

-53.7 KB
Binary file not shown.
Binary file not shown.
-271 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
-282 KB
Binary file not shown.
-267 KB
Binary file not shown.
-271 KB
Binary file not shown.
-61.6 KB
Binary file not shown.
-71.9 KB
Binary file not shown.

docs/get-started/images/cr_login.png

-72.4 KB
Binary file not shown.

docs/get-started/images/cr_login2.png

-187 KB
Binary file not shown.
-191 KB
Binary file not shown.
-125 KB
Binary file not shown.
-79.7 KB
Binary file not shown.

docs/get-started/images/tailor2.png

-69 KB
Binary file not shown.

docs/get-started/images/tailor3.png

-147 KB
Binary file not shown.

docs/get-started/images/ymlrabbit.png

-366 KB
Binary file not shown.

docs/get-started/signup.md

-60
This file was deleted.

0 commit comments

Comments
 (0)