Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Commit5a23ac4

Browse files
harjotgillguritfaqcoderabbitai[bot]
authored
doc fixes (coderabbitai#33)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>---------Co-authored-by: Gur singh <11731008+guritfaq@users.noreply.github.com>Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parentafa2004 commit5a23ac4

37 files changed

+193
-353
lines changed

‎docs/about/_category_.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label:About
2+
position:2
3+
collapsible:true
4+
collapsed:true

‎docs/about/features.md‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title:CodeRabbit in Action
3-
sidebar_label:CodeRabbit in Action
2+
title:High-level Features
3+
sidebar_label:High-level Features
44
description:Learn how CodeRabbit works in a pull request review.
55
---
66

@@ -23,13 +23,19 @@ changes.
2323

2424
###2. Code Review feedback {#code-review-feedback}
2525

26-
Review comments: Review feedback posts as pull request, review comments on the
27-
lines of the code that changed under each file. Any code suggestions are given
28-
in a Diff format, which either be copied or committed within the pull request
29-
with a single click.
26+
Review feedback is posted as review comments on the lines of the code that
27+
changed for each file. Code suggestions are given in a Diff format, which either
28+
be copied or committed within the pull request with a single click.
3029

3130
![Review Feedback](./images/ReviewFeedback.png)
3231

32+
A review status is generated for each commit that is reviewed. It displays the
33+
commit IDs that were reviewed, the files examined and ignored, as well as the
34+
additional comments generated for each review, and so on. Review status is
35+
useful for understanding the auxiliary context of the review.
36+
37+
![Review Status](./images/ReviewStatus.png)
38+
3339
###3. Chat with CodeRabbit {#chat-with-coderabbit}
3440

3541
CodeRabbit provides conversational capability that allows developers and the
@@ -46,15 +52,3 @@ Pull request changes are validated against the linked GitHub or GitLab issue and
4652
identifies all other issues which might be affected by this change.
4753

4854
![Issue Validation](./images/issue-validation.png)
49-
50-
###5. Pull Request review status {#pull-request-review-status}
51-
52-
Review status is generated for each review, including a separate one for each
53-
incremental commit. Displays the commit IDs that were reviewed, the files
54-
examined and ignored, as well as the actionable feedback and additional comments
55-
generated for each review.
56-
57-
![Review Status](./images/ReviewStatus.png)
58-
59-
For information on how to get started with CodeRabbit, visit
60-
the [Get Started page](/get-started/signup)

‎docs/about/pricing.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title:Plans
3-
sidebar_label:Plans
2+
title:PricingPlans
3+
sidebar_label:PricingPlans
44
description:
55
Learn about the plans, pricing, and subscription management of CodeRabbit.
66
---
@@ -92,5 +92,6 @@ These are the hourly usage limits for each developer per repository:
9292
![Free Seat Assignment](./images/cr_seat_free_dark.png#gh-dark-mode-only)
9393
![Free Seat Assignment](./images/cr_seat_free_light.png#gh-light-mode-only)
9494

95-
96-
**Note:** The subscription is limited to human users; bot users are not supported. Thus, pull requests or merge requests created by bots will not be reviewed.
95+
**Note:** The subscription is limited to human users; bot users are not
96+
supported. Thus, pull requests or merge requests created by bots will not be
97+
reviewed.

‎docs/about/support.md‎

Lines changed: 14 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -4,57 +4,16 @@ sidebar_label: Support
44
description:Get help with CodeRabbit and find answers to common questions.
55
---
66

7-
Welcome to CodeRabbit's Support! Please refer tothis section if you encounter
8-
any issues or have questions. Our support team will respond back as soon as
7+
Welcome to CodeRabbit Support! Please refer tothe following sections for
8+
contacting our support team. Our support team will respond back as soon as
99
possible.
1010

11-
###**Common Issues and Answers**
11+
##Community Discord
1212

13-
These are the most common questions our support team receives, and you might
14-
find an answer here
13+
For real-time support and to connect with other CodeRabbit users, join our
14+
[Discord](http://discord.gg/GsXnASn26c).
1515

16-
###Can I switch between different organizations on CodeRabbit?
17-
18-
Yes, you can switch between different organizations on CodeRabbit. To do so,
19-
click on the organization name in the top-right corner of the CodeRabbit UI.
20-
21-
![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
22-
![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)
23-
24-
###Can CodeRabbit subscription be used across multiple organizations?
25-
26-
Subscription seats are tied to the specific GitHub/GitLab organization under
27-
which they are purchased and cannot be used under another organization.
28-
29-
###Can CodeRabbit review my existing PRs after integrating it?
30-
31-
CodeRabbit would by default only review new PRs or existing PRs which have a new
32-
commit after the app is installed. You can, however, use the
33-
`@coderabbitai review` command on the PR to trigger a review of existing PRs.
34-
35-
###Who can add the repositories on CodeRabbit?
36-
37-
You need to be a GitHub/GitLab admin to add the repositories.
38-
39-
###Do I need my own OpenAI key with CodeRabbit Pro?
40-
41-
OpenAI cost is part of the subscription. There is no additional cost for OpenAI.
42-
43-
###What is the difference between CodeRabbit OSS and CodeRabbit Pro?
44-
45-
[`ai-pr-reviewer`](https://github.com/coderabbitai/ai-pr-reviewer) project is
46-
our Open-Source Software (OSS) for pull request reviews. With CodeRabbit OSS,
47-
you need your own OpenAI key, and you will incur OpenAI costs. On the other
48-
hand, with a CodeRabbit Pro subscription, the OpenAI cost is included.
49-
Additionally, CodeRabbit Pro offers advanced prompts and superior noise
50-
reduction features, which are not present in CodeRabbit OSS.
51-
52-
###Can I use both CodeRabbit OSS and CodeRabbit Pro together?
53-
54-
You can, but this will result in duplicate reviews. We suggest you use only one
55-
of the two.
56-
57-
###**Opening a Support Ticket**
16+
##Support Tickets
5817

5918
To get assistance from our support team, open a ticket using the help icon on
6019
the CodeRabbit UI:
@@ -66,13 +25,15 @@ provide the GitHub or GitLab organization name.
6625
![Open a Ticket](./images/cr_support_help_light.png#gh-light-mode-only)
6726
![Open a Ticket](./images/cr_support_help_dark.png#gh-dark-mode-only)
6827

69-
:::tip
28+
##Email Support
7029

71-
To see more common issues faced by CodeRabbit users, visit our FAQ section for
72-
detailed answers and solutions to frequently encountered problems.
30+
You can also reach out to us at
31+
[contact@coderabbit.ai](mailto:contact@coderabbit.ai).
7332

74-
:::
33+
:::tip
7534

76-
###**Community Collaboration**
35+
To see more common issues faced by CodeRabbit users, visit our
36+
[FAQ section](../faq/faq.md) for detailed answers and solutions to frequently
37+
encountered problems.
7738

78-
Consider joining the CodeRabbit community on Discord.
39+
:::

‎docs/faq/faq.md‎

Lines changed: 59 additions & 35 deletions
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 continuouslylearning andimproving, aiming for the highest
13-
possible accuracyin 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-
affecttheaccuracyofthe review.
18+
proficiency of our AI models might vary between languages based on their
19+
popularity andthepublic availabilityoftraining 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 usingopen source projects. CodeRabbit never uses the proprietary
28-
codeon private repositories for training purposes.
30+
We train our system only usingpublicly available datasets. CodeRabbit never
31+
uses the proprietarycodefrom 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[contact@coderabbit.ai](mailto:contact@coderabbit.ai).

‎docs/get-started/add-repo.md‎

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎docs/get-started/analytics.md‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎docs/get-started/images/add2.png‎

-51.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp