You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/overview/introduction.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Developers can interact directly with the CodeRabbit bot within their existing G
21
21
<iframesrc="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>
22
22
</div>
23
23
24
-
## Core features
24
+
## Core features {#features}
25
25
26
26
Core CodeRabbit features include the following:
27
27
@@ -34,15 +34,15 @@ Core CodeRabbit features include the following:
34
34
- Practices strong privacy and security, with no retention of analyzed code.
35
35
- Offers free use for public repositories, and flexible pricing for private codebases.
36
36
37
-
## Seamless workflow integration
37
+
## Seamless workflow integration {#workflow}
38
38
39
39
CodeRabbit shares its reviews as comments attached to pull requests, using the same Git platform that your team already uses. Further commits in the same pull review prompt CodeRabbit to make further reviews, using the earlier reviews as context.
40
40
41
41
Each time that it performs a code review, CodeRabbit runs the relevant code changes through [an array of industry-standard code linters, security analyzers, and other tools](/tools/). CodeRabbit synthesizes the output of these tools into its reviews, offering a high-level analysis that can suggest areas for further focus and improvement.
42
42
43
43
Your team can have conversations with CodeRabbit about its reviews by replying to it with follow-up comments on pull requests, asking it questions or making observations about the review using natural language. CodeRabbit continues the conversation appropriately, offering further insights about the code changes, or adjusting its own review style based on feedback.
As you interact with CodeRabbit through chat, it learns the review preferences of your team, and applies them to all future reviews on a given repository.
48
48
@@ -54,7 +54,7 @@ If you need to fine-tune CodeRabbit's behavior beyond this, then you can [add a
54
54
55
55
No matter how you tune and customize CodeRabbit, its default settings make it useful out of the box, able to meaningfully review pull requests within minutes of its introduction to a repository.
56
56
57
-
### Git platform integration
57
+
### Git platform integration {#integration}
58
58
59
59
CodeRabbit integrates in just a few clicks with many popular Git platforms:
60
60
@@ -65,7 +65,7 @@ CodeRabbit integrates in just a few clicks with many popular Git platforms:
65
65
66
66
For more information, see [Supported Git Platforms](/platforms/).
67
67
68
-
### Issue-management integration
68
+
### Issue-management integration {#issues}
69
69
70
70
You can integrate CodeRabbit with issue-management platforms. This lets you ask CodeRabbit to create tickets during code reviews, or chat with CodeRabbit about your code from within issue comments. Compatible platforms include the following:
71
71
@@ -76,7 +76,7 @@ You can integrate CodeRabbit with issue-management platforms. This lets you ask
76
76
77
77
For more information, see [Issue Creation](/guides/issue-creation) and [Issue Chat](/guides/issue-chat).
78
78
79
-
## Data privacy and security
79
+
## Data privacy and security {#security}
80
80
81
81
CodeRabbit collects only the minimum amount of information needed to provide you with our code review services. Our privacy and security posture centers around protecting your data through ephemerality:
82
82
@@ -88,7 +88,7 @@ CodeRabbit collects only the minimum amount of information needed to provide you
88
88
89
89
For more information about how we protect your data, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai).
The Pro and Enterprise subscription tiers use seat-based pricing. For more information, see [Pricing](https://www.coderabbit.ai/pricing).
110
110
111
-
### Free use for public repositories
111
+
### Free use for public repositories {#free}
112
112
113
113
Public repositories can make full, free use of CodeRabbit's core code-review features, with no seat limit. This applies to all subscription tiers, including the free Lite tier. Rate limits might apply.
114
114
115
-
### Discounts for startups
115
+
### Discounts for startups {#startups}
116
116
117
117
Eligible startup companies can use the CodeRabbit Startup Program, which offers a 50 percent discount on paid-tier CodeRabbit subscriptions for three months. For more information, see [Startup Program](https://www.coderabbit.ai/startup-program).
118
118
119
-
## Review local changes from within VSCode
119
+
## Review local changes from within VSCode {#vscode}
120
120
121
121
As a separate, free product, CodeRabbit offers a VSCode extension that brings a subset of core CodeRabbit features to VSCode. This lets you use the power of CodeRabbit to tune and tidy your code changes locally before pushing your changes into a formal pull request for more thorough reviews.
122
122
123
123
For more information, see [Review local changes](/code-editors).
124
124
125
-
## What's next
125
+
## What's next {#whats-next}
126
126
127
127
-[Quickstart](/getting-started/quickstart/) lets you experience your first CodeRabbit code review first-hand.
0 commit comments