Skip to content

Commit 44f57e0

Browse files
committed
Update FAQ with CodeRabbit comparison and CodeRabbit's uniqueness
1 parent a433763 commit 44f57e0

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

docs/faq.md

+18
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,24 @@ CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
4747
researching and testing upcoming LLMs to ensure we're offering the most precise
4848
reviews possible.
4949

50+
#### How does CodeRabbit compare to other AI code generators?
51+
52+
Code reviews remain essential, whether the code is written by a human or a bot.
53+
This is mainly because the perspective of the reviewer differs from that of the
54+
code generator, whether human or machine. This distinction is precisely why
55+
human peer reviews have been effective for so long. While AI-powered
56+
code-generation tools like GitHub Copilot hold immense potential, it's important to recognize that
57+
these generators are still in their early stages and may not be equipped to
58+
auto-generate meaningful code for moderately complex applications.
59+
60+
#### How is CodeRabbit different from other code review tools?
61+
62+
Traditional code review tools excel in linting and static analysis, but they
63+
fall short in providing context-aware, conversational feedback with actionable
64+
suggestions for changes that can be directly committed. On the other hand,
65+
**CodeRabbit** leverages AI to understand the intent behind the code changes and
66+
provide human-like feedback for applying the best practices.
67+
5068
### Subscription
5169

5270
#### Can a CodeRabbit subscription be used across multiple organizations?

docs/introduction.md

+3-21
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: introduction
3-
title: What is CodeRabbit?
3+
title: Introduction
44
sidebar_label: Introduction
55
sidebar_position: 1
66
description:
@@ -10,6 +10,8 @@ description:
1010
slug: "/"
1111
---
1212

13+
<iframe width="560" height="315" src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe>
14+
1315
**CodeRabbit** is an innovative, AI-first code reviewer. It provides
1416
context-aware review feedback on a pull request within minutes, thereby
1517
significantly reducing the time and effort associated with manual code reviews.
@@ -23,8 +25,6 @@ performing continuous, incremental reviews for each commit within a pull
2325
request. Review feedback is sent back to the pull requests and can be directly
2426
committed.
2527

26-
<iframe width="560" height="315" src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe>
27-
2828
**CodeRabbit** integrates into code repositories using GitHub or GitLab webhooks
2929
and monitors events related to Pull Request (PR) and Merge Request (MR) changes.
3030
A comprehensive review is performed when a PR or MR is created, and for
@@ -53,21 +53,3 @@ complies with SOC2 Type II and GDPR standards.
5353

5454
Opting Out: You can choose to opt out of data storage at any time. Opting out
5555
won't affect your access but will limit the personalization of the reviews.
56-
57-
## CodeRabbit with other AI code generators
58-
59-
Code reviews remain essential, whether the code is written by a human or a bot.
60-
This is mainly because the perspective of the reviewer differs from that of the
61-
code generator, whether human or machine. This distinction is precisely why
62-
human peer reviews have been effective for so long. While AI-powered
63-
code-generation tools like GitHub Copilot hold immense potential, it's important to recognize that
64-
these generators are still in their early stages and may not be equipped to
65-
auto-generate meaningful code for moderately complex applications.
66-
67-
## CodeRabbit is different
68-
69-
Traditional code review tools excel in linting and static analysis, but they
70-
fall short in providing context-aware, conversational feedback with actionable
71-
suggestions for changes that can be directly committed. On the other hand,
72-
**CodeRabbit** leverages AI to understand the intent behind the code changes and
73-
provide human-like feedback for applying the best practices.

0 commit comments

Comments
 (0)