Skip to content

Commit 9cfa6c4

Browse files
docs: add dynamic badge for CodeRabbit reviews and update language support section
1 parent 7edc335 commit 9cfa6c4

File tree

1 file changed

+3
-119
lines changed

1 file changed

+3
-119
lines changed

README.md

+3-119
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
1414
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/coderabbitai/coderabbit-docs/pulls)
1515
[![Node.js CI](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml/badge.svg)](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml)
1616

17+
![CodeRabbit Reviews](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.coderabbit.ai%2Fstats%2Fgithub%2Fcoderabbitai%2Fcoderabbit-docs&query=reviews&suffix=%20Reviews&style=flat&label=CodeRabbit&link=https%3A%2F%2Fcoderabbit.ai)
18+
1719
## About CodeRabbit
1820

1921
> **CodeRabbit** is an AI-powered code reviewer that delivers context-aware feedback on pull requests within minutes, reducing the time and effort needed for manual code reviews. It provides a fresh perspective and catches issues that are often missed, enhancing the overall review quality.
@@ -24,125 +26,7 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
2426
- Interactive chat
2527
- Sequence diagrams
2628
- Integration with popular version control platforms
27-
- Support for multiple programming languages
28-
29-
## Getting Started with CodeRabbit
30-
31-
Follow these steps to and start using CodeRabbit:
32-
33-
1. **Sign Up**
34-
Visit [coderabbit.ai](https://coderabbit.ai/) and create your account.
35-
36-
2. **Connect Your Repository**
37-
Link your repository from one of the supported platforms:
38-
39-
- GitHub
40-
- GitLab
41-
- Azure DevOps
42-
43-
3. **Configure Settings**
44-
Customize your preferences in the CodeRabbit dashboard as per your project's needs.
45-
46-
4. **Initiate Code Reviews**
47-
Start creating pull requests on your platform, and let CodeRabbit assist with intelligent code reviews.
48-
49-
# Configuring CodeRabbit
50-
51-
CodeRabbit offers flexible configuration options. There are two primary methods for configuring CodeRabbit:
52-
53-
1. Using the CodeRabbit UI (Web Interface)
54-
2. Using a YAML Configuration File
55-
56-
## 1. Using the CodeRabbit UI
57-
58-
When you create an account and add repositories through the CodeRabbit web interface, you can configure settings for your organization and individual repositories.
59-
60-
### Steps
61-
62-
1. Sign up or log in at [coderabbit.ai](https://coderabbit.ai)
63-
2. Navigate to the "Organization Settings" section or "Repositories" section
64-
3. Click "Add Repositories" to connect your Git repositories
65-
4. Use the UI to configure settings for each repository or at the organization level
66-
67-
### Available UI Configuration Options
68-
69-
#### General Settings
70-
71-
- Review Language: Choose the natural language for CodeRabbit to write reviews (e.g., English (US))
72-
- Tone Instructions: Set the tone for reviews and chat
73-
- Early Access: Enable or disable early-access features
74-
- Fine-tune Your Reviews: Allow CodeRabbit to learn from your usage and improve over time
75-
76-
#### Review Settings
77-
78-
- Customize review profile, summary options, and automated review preferences
79-
80-
#### Chat Settings
81-
82-
- Configure chat-related options
83-
84-
#### Knowledge Base
85-
86-
- Set up and manage your organization's knowledge base
87-
88-
#### API Keys
89-
90-
- Create and manage API keys for accessing the CodeRabbit API
91-
92-
> **Note:** Settings configured at the repository level will override organization-level settings.
93-
94-
## 2. Using a YAML Configuration File
95-
96-
For more advanced and version-controlled configuration, you can use a YAML file in your repository.
97-
98-
### Steps
99-
100-
1. Create a file named `.coderabbit.yaml` in the root of your repository
101-
2. Add your configuration options to the file
102-
3. Commit and push the file to your repository
103-
104-
### Sample `.coderabbit.yaml`
105-
106-
```yaml
107-
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
108-
language: "en-US"
109-
early_access: false
110-
reviews:
111-
profile: "chill"
112-
request_changes_workflow: false
113-
high_level_summary: true
114-
poem: true
115-
review_status: true
116-
collapse_walkthrough: false
117-
auto_review:
118-
enabled: true
119-
drafts: false
120-
chat:
121-
auto_reply: true
122-
```
123-
124-
### Key Configuration Options
125-
126-
- `language`: Set the language for CodeRabbit's responses
127-
- `early_access`: Enable/disable early access features
128-
- `reviews`: Configure review behavior and style
129-
- `chat`: Set chat-related options
130-
131-
For a complete list of configuration options, refer to the [CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/schema.v2.json).
132-
133-
## Configuration Precedence
134-
135-
CodeRabbit uses the following order of precedence for configuration:
136-
137-
1. YAML file in the repository (highest precedence)
138-
2. UI configuration for individual repositories
139-
3. UI configuration for the organization (lowest precedence)
140-
141-
## Tips
142-
143-
- To convert existing UI configuration to YAML, use the `@coderabbitai configuration` command on any PR.
144-
- Ensure the `.coderabbit.yaml` file is present in the feature branch for CodeRabbit to review.
145-
- New pull requests or incremental commits will trigger CodeRabbit reviews once configured.
29+
- Support for all programming languages
14630

14731
## Table of Contents
14832

0 commit comments

Comments
 (0)