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
@@ -24,125 +25,7 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
24
25
- Interactive chat
25
26
- Sequence diagrams
26
27
- 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
0 commit comments