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: README.md
+31-24
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ Follow these steps to and start using CodeRabbit:
34
34
35
35
2.**Connect Your Repository**
36
36
Link your repository from one of the supported platforms:
37
+
37
38
- GitHub
38
39
- GitLab
39
40
- Azure DevOps
@@ -55,30 +56,36 @@ CodeRabbit offers flexible configuration options. There are two primary methods
55
56
56
57
When you create an account and add repositories through the CodeRabbit web interface, you can configure settings for your organization and individual repositories.
57
58
58
-
### Steps:
59
+
### Steps
60
+
59
61
1. Sign up or log in at [coderabbit.ai](https://coderabbit.ai)
60
62
2. Navigate to the "Organization Settings" section or "Repositories" section
61
63
3. Click "Add Repositories" to connect your Git repositories
62
64
4. Use the UI to configure settings for each repository or at the organization level
63
65
64
-
### Available UI Configuration Options:
66
+
### Available UI Configuration Options
67
+
68
+
#### General Settings
65
69
66
-
#### General Settings:
67
70
- Review Language: Choose the natural language for CodeRabbit to write reviews (e.g., English (US))
68
71
- Tone Instructions: Set the tone for reviews and chat
69
72
- Early Access: Enable or disable early-access features
70
73
- Fine-tune Your Reviews: Allow CodeRabbit to learn from your usage and improve over time
71
74
72
-
#### Review Settings:
75
+
#### Review Settings
76
+
73
77
- Customize review profile, summary options, and automated review preferences
74
78
75
-
#### Chat Settings:
79
+
#### Chat Settings
80
+
76
81
- Configure chat-related options
77
82
78
-
#### Knowledge Base:
83
+
#### Knowledge Base
84
+
79
85
- Set up and manage your organization's knowledge base
80
86
81
-
#### API Keys:
87
+
#### API Keys
88
+
82
89
- Create and manage API keys for accessing the CodeRabbit API
83
90
84
91
> **Note:** Settings configured at the repository level will override organization-level settings.
@@ -87,32 +94,33 @@ When you create an account and add repositories through the CodeRabbit web inter
87
94
88
95
For more advanced and version-controlled configuration, you can use a YAML file in your repository.
89
96
90
-
### Steps:
97
+
### Steps
98
+
91
99
1. Create a file named `.coderabbit.yaml` in the root of your repository
0 commit comments