Skip to content

Commit 2cebda9

Browse files
authored
Merge pull request #6 from coderabbitai/fix/introductionDocs
2 parents 3d28245 + fd505b7 commit 2cebda9

File tree

2 files changed

+20
-120
lines changed

2 files changed

+20
-120
lines changed

blog/2023-09-25-coderabbit-deep-dive.md

-110
This file was deleted.

docs/introduction/introduction.md

+20-10
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,32 @@ slug: "/"
2424
<meta name="twitter:description" content="Accelerate Code Reviews with AI" />
2525
</head>
2626

27-
**CodeRabbit** is an innovative, AI-driven platform that revolutionizes the way pull requests are reviewed. It enhances code quality while significantly reducing the time and effort associated with manual code reviews. The platform provides detailed, line-by-line feedback on code changes, offering suggestions for improvements and corrections to enhance code efficiency and robustness. This analysis includes a comprehensive review of logic, syntax, and coding style, along with potential optimizations and corrections.
27+
**CodeRabbit** is an innovative, AI-first code reviewer. It provides context aware review feedback on a pull request within minutes, thereby significantly reducing the time and effort associated with manual code reviews. Secondly, it brings a different perspective to the reviews and finds issues often missed by the human eye. Developers can chat with the bot within the code, which allows them to provide additional context, ask questions, or have the bot generate code. It learns from your suggestions and gets better overtime.
2828

29-
Moreover, **CodeRabbit** can triage changes and flag pull requests that require more careful scrutiny. Our bot offers conversational capabilities within the context of the code, allowing developers to provide additional context, ask questions, or even generate code. **CodeRabbit** seamlessly integrates with GitHub and GitLab repositories, performing continuous, incremental reviews for each commit within a pull request. Review feedback is sent back to the pull requests and can be directly committed.
29+
**CodeRabbit** seamlessly integrates with GitHub and GitLab repositories, performing continuous, incremental reviews for each commit within a pull request. Review feedback is sent back to the pull requests and can be directly committed.
3030

31-
## Do you need CodeRabbit with the AI code generators or co-pilot?
31+
### How does CodeRabbit work?
3232

33-
Code reviews remain essential, whether the code is written by a human or a bot. This is mainly because the perspective of the reviewer differs from that of the code generator, whether human or machine. This distinction is precisely why human peer reviews have been effective for so long. While AI-powered code-generation tools hold immense potential, it's important to recognize that these generators are still in their early stages and may not be equipped to auto-generate meaningful code for moderately complex applications.
33+
**CodeRabbit** integrates into code repositories using GitHub or GitLab webhooks and monitors events related to Pull Request (PR) and Merge Request (MR) changes. A comprehensive review is performed when a PR or MR is created, and for incremental commits and comments addressed to the bot. The feedback is then sent directly back to the PR or MR.
34+
35+
![](../about/images/CodeRabbitFlow.png)
36+
37+
### Data, Privacy, and Security
38+
39+
**CodeRabbit** does not use data collected during code reviews to train or influence the models. Queries to the Large Language Model (LLM) are ephemeral. Neither we nor the LLM we use share any data collected during the code review process with other third parties.
3440

35-
## How does CodeRabbit work?
41+
Does CodeRabbit store my Data? We store embeddings of your conversations, which are used to improve future reviews.
3642

37-
**CodeRabbit** seamlessly integrates into code repositories using GitHub or GitLab webhooks and monitors events related to Pull Request (PR) and Merge Request (MR) changes. A comprehensive review is performed when a PR or MR is created, and for incremental commits and comments addressed to the bot. The feedback is then sent directly back to the PR or MR.
43+
Compliance and Data Privacy: Your data is kept confidential, isolated, and used only to improve your reviews. Data storage complies with SOC2 Type II, GDPR, and HIPAA standards.
3844

39-
![](../about/./images/CodeRabbitFlow.png)
45+
Opting Out: You can choose to opt out of data storage at any time. Opting out won't affect your access but will limit the personalization of the reviews.
46+
47+
### Do you need CodeRabbit with the AI code generators or co-pilot?
48+
49+
Code reviews remain essential, whether the code is written by a human or a bot. This is mainly because the perspective of the reviewer differs from that of the code generator, whether human or machine. This distinction is precisely why human peer reviews have been effective for so long. While AI-powered code-generation tools hold immense potential, it's important to recognize that these generators are still in their early stages and may not be equipped to auto-generate meaningful code for moderately complex applications.
4050

41-
## Data, Privacy, and Security.
51+
### How is CodeRabbit different from existing code review tools?
4252

43-
**CodeRabbit** does not utilize data collected during code reviews to train, refine, or influence our models, or any third-party models. The collected data is immediately discarded after the review is complete. We maintain no copies or backups of this review data, and it is purged from our systems without delay. Queries to the Large Language Model (LLM) are ephemeral. Neither we nor the LLM we use share any data collected during the code review process with other third parties.
53+
Existing code review tools are good at linting and static code analysis; however, they lack context-aware, human-like review feedback.
4454

45-
For information on how to get started with **CodeRabbit**, please visit the [Get Started page](/get-started/signup).
55+
For information on how to get started with **CodeRabbit**, please visit the [Get Started page](https://coderabbit.ai/docs/get-started/signup).

0 commit comments

Comments
 (0)