Skip to content

Commit 4d1ce4a

Browse files
harjotgilltyaga001
authored andcommitted
review feedback
1 parent e36c04b commit 4d1ce4a

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/guides/customize-coderabbit.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ description:
88
---
99

1010
CodeRabbit offers various customization options to tailor the reviews to your
11-
specific requirements. Customizations can be made using one of the below options
12-
:
11+
requirements. Customizations can be made using one of the below options :
1312

1413
1. **Customization via CodeRabbit YAML File** _(Recommended)_
1514
2. **Customization via CodeRabbit UI**
@@ -19,7 +18,8 @@ Customization defined in the YAML file overrides the settings in the UI.
1918
### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit)
2019

2120
You can add a `.coderabbit.yaml` configuration file to your repositories. Below
22-
is a sample YAML file that can be used as a starting point and change as needed:
21+
is a sample YAML file that can be used as a starting point and changed as
22+
needed:
2323

2424
#### version 2: `Current`
2525

@@ -217,14 +217,14 @@ Reviews can also be customized through the UI under repository settings:
217217
**Path-based instructions :** Provide additional review guidelines based on the
218218
file paths using glob patterns.
219219

220-
For further guidance, please refer this
220+
For further guidance, please refer to this
221221
section [Prompt Customization](/guides/prompt-customization)
222222

223223
**Language Selection:** Select the natural language in which you want the review
224224
feedback. CodeRabbit supports most of the widely used languages. The default
225225
language is English.
226226

227-
**Disable High Level Summary:** This allows disabling high level summary added
227+
**Disable High Level Summary:** This allows disabling high-level summary added
228228
with the pull request description.
229229

230230
---
@@ -236,7 +236,7 @@ with the pull request description.
236236
**Disable Reviews:** Disables automatic code reviews for the repository. Reviews
237237
can be initiated on-demand using CodeRabbit commands.
238238

239-
**Enable Draft Pull request Reviews:** Select whether CodeRabbit should review
239+
**Enable draft pull request reviews:** Select whether CodeRabbit should review
240240
the draft pull requests.
241241

242242
**Configure reviews using pull request labels:** Select specific pull request

docs/introduction/introduction.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ id: introduction
33
title: What is CodeRabbit?
44
sidebar_label: Introduction
55
description:
6-
CodeRabbit is an innovative, AI-first code reviewer. It provides context aware
6+
CodeRabbit is an innovative, AI-first code reviewer. It provides context-aware
77
review feedback on a pull request within minutes, thereby significantly
88
reducing the time and effort associated with manual code reviews.
99
slug: "/"
1010
---
1111

12-
**CodeRabbit** is an innovative, AI-first code reviewer. It provides context
13-
aware review feedback on a pull request within minutes, thereby significantly
14-
reducing the time and effort associated with manual code reviews. Secondly, it
15-
brings a different perspective to the reviews and finds issues often missed by
16-
the human eye. Developers can chat with the bot within the code, which allows
17-
them to provide additional context, ask questions, or have the bot generate
18-
code. It learns from your suggestions and gets better overtime.
12+
**CodeRabbit** is an innovative, AI-first code reviewer. It provides
13+
context-aware review feedback on a pull request within minutes, thereby
14+
significantly reducing the time and effort associated with manual code reviews.
15+
Secondly, it brings a different perspective to the reviews and finds issues
16+
often missed by the human eye. Developers can chat with the bot within the code,
17+
which allows them to provide additional context, ask questions, or have the bot
18+
generate code. It learns from your suggestions and gets better overtime.
1919

2020
**CodeRabbit** seamlessly integrates with GitHub and GitLab repositories,
2121
performing continuous, incremental reviews for each commit within a pull
@@ -42,7 +42,7 @@ process with other third parties.
4242
Does CodeRabbit store my Data? We store embeddings of your conversations, which
4343
are used to improve future reviews for your organization.
4444

45-
Compliance and Data Privacy: Your data is kept confidential, isolated by
45+
Compliance and Data Privacy: Your data is kept confidential, isolated by the
4646
organization, and used only to improve your organization reviews. Data storage
4747
complies with SOC2 Type II, GDPR, and HIPAA standards.
4848

0 commit comments

Comments
 (0)