-
Notifications
You must be signed in to change notification settings - Fork 32
doc fixes #33
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.
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
doc fixes #33
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
76aa32c
doc fixes
harjotgill ca3d6aa
doc fixes
harjotgill 2407d88
doc fixes
harjotgill c5a83b3
Update docs/guides/configure-coderabbit.md
guritfaq 70c3c6f
doc fixes
harjotgill 9b0656f
Update docs/guides/configure-coderabbit.md
guritfaq File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
label: About | ||
position: 2 | ||
collapsible: true | ||
collapsed: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,57 +4,16 @@ sidebar_label: Support | |
description: Get help with CodeRabbit and find answers to common questions. | ||
--- | ||
|
||
Welcome to CodeRabbit's Support! Please refer to this section if you encounter | ||
any issues or have questions. Our support team will respond back as soon as | ||
Welcome to CodeRabbit Support! Please refer to the following sections for | ||
contacting our support team. Our support team will respond back as soon as | ||
possible. | ||
|
||
### **Common Issues and Answers** | ||
## Community Discord | ||
|
||
These are the most common questions our support team receives, and you might | ||
find an answer here | ||
For real-time support and to connect with other CodeRabbit users, join our | ||
[Discord](http://discord.gg/GsXnASn26c). | ||
|
||
### Can I switch between different organizations on CodeRabbit? | ||
|
||
Yes, you can switch between different organizations on CodeRabbit. To do so, | ||
click on the organization name in the top-right corner of the CodeRabbit UI. | ||
|
||
 | ||
 | ||
|
||
### Can CodeRabbit subscription be used across multiple organizations? | ||
|
||
Subscription seats are tied to the specific GitHub/GitLab organization under | ||
which they are purchased and cannot be used under another organization. | ||
|
||
### Can CodeRabbit review my existing PRs after integrating it? | ||
|
||
CodeRabbit would by default only review new PRs or existing PRs which have a new | ||
commit after the app is installed. You can, however, use the | ||
`@coderabbitai review` command on the PR to trigger a review of existing PRs. | ||
|
||
### Who can add the repositories on CodeRabbit? | ||
|
||
You need to be a GitHub/GitLab admin to add the repositories. | ||
|
||
### Do I need my own OpenAI key with CodeRabbit Pro? | ||
|
||
OpenAI cost is part of the subscription. There is no additional cost for OpenAI. | ||
|
||
### What is the difference between CodeRabbit OSS and CodeRabbit Pro? | ||
|
||
[`ai-pr-reviewer`](https://github.com/coderabbitai/ai-pr-reviewer) project is | ||
our Open-Source Software (OSS) for pull request reviews. With CodeRabbit OSS, | ||
you need your own OpenAI key, and you will incur OpenAI costs. On the other | ||
hand, with a CodeRabbit Pro subscription, the OpenAI cost is included. | ||
Additionally, CodeRabbit Pro offers advanced prompts and superior noise | ||
reduction features, which are not present in CodeRabbit OSS. | ||
|
||
### Can I use both CodeRabbit OSS and CodeRabbit Pro together? | ||
|
||
You can, but this will result in duplicate reviews. We suggest you use only one | ||
of the two. | ||
|
||
### **Opening a Support Ticket** | ||
## Support Tickets | ||
|
||
To get assistance from our support team, open a ticket using the help icon on | ||
the CodeRabbit UI: | ||
|
@@ -66,13 +25,15 @@ provide the GitHub or GitLab organization name. | |
 | ||
 | ||
|
||
:::tip | ||
## Email Support | ||
|
||
To see more common issues faced by CodeRabbit users, visit our FAQ section for | ||
detailed answers and solutions to frequently encountered problems. | ||
You can also reach out to us at | ||
[[email protected]](mailto:[email protected]). | ||
|
||
::: | ||
:::tip | ||
|
||
### **Community Collaboration** | ||
To see more common issues faced by CodeRabbit users, visit our | ||
[FAQ section](../faq/faq.md) for detailed answers and solutions to frequently | ||
encountered problems. | ||
|
||
Consider joining the CodeRabbit community on Discord. | ||
::: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,81 +4,109 @@ sidebar_label: FAQs | |
description: Frequently asked questions about CodeRabbit. | ||
--- | ||
|
||
#### **1. How accurate is CodeRabbit's review?** | ||
#### How accurate is CodeRabbit's review? | ||
|
||
Early adoption results for CodeRabbit have been highly promising, demonstrating | ||
significant accuracy in code reviews. However, it's crucial to understand that | ||
AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our | ||
technology is continuously learning and improving, aiming for the highest | ||
possible accuracy in reviews. | ||
technology is continuously improving, aiming for the highest possible accuracy | ||
in reviews. | ||
|
||
#### **2. Which programming languages does CodeRabbit support?** | ||
#### Which programming languages does CodeRabbit support? | ||
|
||
CodeRabbit is designed to work with all programming languages. However, the | ||
proficiency of our AI models might vary between languages, which could slightly | ||
affect the accuracy of the review. | ||
proficiency of our AI models might vary between languages based on their | ||
popularity and the public availability of training data. | ||
|
||
#### **3. Does CodeRabbit store my code ?** | ||
#### Does CodeRabbit store my code? | ||
|
||
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. | ||
We do not store your code. The code collected at the time of the review is | ||
disposed off as soon as the review is complete. During the review, there is | ||
complete data isolation of the code being reviewed, and no one from CodeRabbit | ||
or outside has access to the code. | ||
|
||
#### **4. Does CodeRabbit use my proprietary code for training language models?** | ||
#### Does CodeRabbit use my proprietary code for training language models? | ||
|
||
We train our system only using open source projects. CodeRabbit never uses the proprietary | ||
code on private repositories for training purposes. | ||
We train our system only using publicly available datasets. CodeRabbit never | ||
uses the proprietary code from private repositories for training purposes. | ||
|
||
#### **5. What Large Language Models does CodeRabbit use?** | ||
#### Can I switch between different organizations on CodeRabbit? | ||
|
||
Yes, you can switch between different organizations on CodeRabbit. To do so, | ||
click on the organization name in the top-right corner of the CodeRabbit UI. | ||
|
||
 | ||
 | ||
|
||
#### Can CodeRabbit subscription be used across multiple organizations? | ||
|
||
Subscription seats are tied to the specific GitHub/GitLab organization under | ||
which they are purchased and cannot be used under another organization. | ||
|
||
#### Can CodeRabbit review my existing PRs after integrating it? | ||
|
||
CodeRabbit would by default only review new PRs or existing PRs which have a new | ||
commit after the app is installed. You can, however, use the | ||
`@coderabbitai review` command on the PR to trigger a review of existing PRs. | ||
|
||
#### Who can add the repositories on CodeRabbit? | ||
|
||
You need to be a GitHub/GitLab admin to add the repositories. | ||
|
||
#### Do I need my own OpenAI key with CodeRabbit Pro? | ||
|
||
OpenAI cost is included as part of the subscription. You don't need to have your | ||
own OpenAI key. | ||
|
||
#### What Large Language Models does CodeRabbit use? | ||
|
||
CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're | ||
researching and testing upcoming LLMs to ensure we're offering the most precise | ||
reviews possible. | ||
|
||
#### **6. Can I customize CodeRabbit?** | ||
#### Can I customize CodeRabbit? | ||
|
||
Reviews are customizable. For information, check out our | ||
[Get Started page](../get-started/signup.md). | ||
[Customization](../guides/review-instructions.md) guide. | ||
|
||
#### **7. Can I choose a language other than English for the reviews?** | ||
#### Can I choose a language other than English for the reviews? | ||
|
||
CodeRabbit supports most widely used languages. You can configure this in the | ||
repository settings. | ||
|
||
#### **8. What access does CodeRabbit need to my repositories?** | ||
#### What access does CodeRabbit need to my repositories? | ||
|
||
CodeRabbit requests minimal access to perform code reviews and post comments on | ||
Pull Requests. On GitHub, it requires read access to metadata, code, | ||
discussions, issues, and read/write access to the pull requests. On GitLab, it | ||
requires read access to the repository, and the CodeRabbit Bot user requires a | ||
developer role. | ||
|
||
#### **9. How can I add or remove users for my subscription?** | ||
#### How can I add or remove users for my subscription? | ||
|
||
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add | ||
or remove users as needed. | ||
|
||
#### **10. How can I interact with the CodeRabbit bot?** | ||
#### How can I interact with the CodeRabbit bot? | ||
|
||
To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are | ||
team members collaborating on pull requests, the bot stays silent by default but | ||
can be engaged by tagging **@Coderabbitai**. This feature allows you to provide | ||
can be engaged by tagging **@coderabbitai**. This feature allows you to provide | ||
context, generate test cases, or ask for specific code suggestions, all within | ||
the context of your code lines or entire files. | ||
|
||
#### **11. Can individual developers use CodeRabbit?** | ||
#### Can individual developers use CodeRabbit? | ||
|
||
Absolutely! Whether you're an individual developer or part of an organization, | ||
CodeRabbit can be your coding assistant, providing you with invaluable | ||
suggestions. | ||
|
||
#### **12. Which branches are the pull requests reviewed on?** | ||
#### Which branches are the pull requests reviewed on? | ||
|
||
CodeRabbit reviews pull requests on the default branch. | ||
CodeRabbit reviews pull requests on the default branch by default. You can | ||
change this in the repository settings. | ||
|
||
#### **13. Is it possible for CodeRabbit to include additional branches for review?** | ||
|
||
Yes, you can change it under the repository settings. | ||
|
||
#### **14. CodeRabbit Usage Limits** | ||
#### CodeRabbit Usage Limits | ||
|
||
There are hourly rate limits for each developer per repository: | ||
|
||
|
@@ -89,18 +117,14 @@ There are hourly rate limits for each developer per repository: | |
In-trial and open-source plans have lower rate limits than the paid plan. In all | ||
cases, we re-allow further reviews/conversations after a brief timeout. | ||
|
||
#### **15. I can't add CodeRabbit to my GitLab Repositories?** | ||
#### I can't add CodeRabbit to my GitLab Repositories. What should I do? | ||
|
||
If there are any access restrictions by domain, then you will need to add | ||
`coderabbit.ai` as an allowed domain. | ||
|
||
:::note | ||
:::tip | ||
|
||
We are continually innovating and enhancing our application with new | ||
capabilities. Stay tuned and follow us for updates as new exciting features are | ||
built. We're committed to making your experience with CodeRabbit even better. | ||
If you have further questions or need additional information, please check out | ||
our [Support](../about/support.md) page for more details. | ||
|
||
::: | ||
|
||
If you have further questions or need additional information, don't hesitate to | ||
reach out to us at [[email protected]](mailto:[email protected]). |
File renamed without changes
File renamed without changes
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.