Skip to content

Commit 312b4d7

Browse files
authored
⚡️ Switch to pnpm (#124)
1 parent 5a45cbd commit 312b4d7

File tree

4 files changed

+10790
-15423
lines changed

4 files changed

+10790
-15423
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@
2020
npm-debug.log*
2121
yarn-debug.log*
2222
yarn-error.log*
23+
package-lock.json
2324
yarn.lock

README.md

+31-24
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Follow these steps to and start using CodeRabbit:
3434

3535
2. **Connect Your Repository**
3636
Link your repository from one of the supported platforms:
37+
3738
- GitHub
3839
- GitLab
3940
- Azure DevOps
@@ -55,30 +56,36 @@ CodeRabbit offers flexible configuration options. There are two primary methods
5556

5657
When you create an account and add repositories through the CodeRabbit web interface, you can configure settings for your organization and individual repositories.
5758

58-
### Steps:
59+
### Steps
60+
5961
1. Sign up or log in at [coderabbit.ai](https://coderabbit.ai)
6062
2. Navigate to the "Organization Settings" section or "Repositories" section
6163
3. Click "Add Repositories" to connect your Git repositories
6264
4. Use the UI to configure settings for each repository or at the organization level
6365

64-
### Available UI Configuration Options:
66+
### Available UI Configuration Options
67+
68+
#### General Settings
6569

66-
#### General Settings:
6770
- Review Language: Choose the natural language for CodeRabbit to write reviews (e.g., English (US))
6871
- Tone Instructions: Set the tone for reviews and chat
6972
- Early Access: Enable or disable early-access features
7073
- Fine-tune Your Reviews: Allow CodeRabbit to learn from your usage and improve over time
7174

72-
#### Review Settings:
75+
#### Review Settings
76+
7377
- Customize review profile, summary options, and automated review preferences
7478

75-
#### Chat Settings:
79+
#### Chat Settings
80+
7681
- Configure chat-related options
7782

78-
#### Knowledge Base:
83+
#### Knowledge Base
84+
7985
- Set up and manage your organization's knowledge base
8086

81-
#### API Keys:
87+
#### API Keys
88+
8289
- Create and manage API keys for accessing the CodeRabbit API
8390

8491
> **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
8794

8895
For more advanced and version-controlled configuration, you can use a YAML file in your repository.
8996

90-
### Steps:
97+
### Steps
98+
9199
1. Create a file named `.coderabbit.yaml` in the root of your repository
92100
2. Add your configuration options to the file
93101
3. Commit and push the file to your repository
94102

95-
### Sample `.coderabbit.yaml`:
103+
### Sample `.coderabbit.yaml`
96104

97105
```yaml
98106
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
99107
language: "en-US"
100108
early_access: false
101109
reviews:
102-
profile: "chill"
103-
request_changes_workflow: false
104-
high_level_summary: true
105-
poem: true
106-
review_status: true
107-
collapse_walkthrough: false
108-
auto_review:
109-
enabled: true
110-
drafts: false
110+
profile: "chill"
111+
request_changes_workflow: false
112+
high_level_summary: true
113+
poem: true
114+
review_status: true
115+
collapse_walkthrough: false
116+
auto_review:
117+
enabled: true
118+
drafts: false
111119
chat:
112-
auto_reply: true
120+
auto_reply: true
113121
```
114122
115-
### Key Configuration Options:
123+
### Key Configuration Options
116124
117125
- `language`: Set the language for CodeRabbit's responses
118126
- `early_access`: Enable/disable early access features
@@ -155,13 +163,13 @@ cd coderabbit-docs
155163
2. Install dependencies:
156164

157165
```bash
158-
npm install
166+
pnpm install
159167
```
160168

161169
3. Start the development server:
162170

163171
```bash
164-
docusaurus start
172+
pnpm start
165173
```
166174

167175
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
@@ -198,7 +206,6 @@ docusaurus build
198206
199207
This command generates static content into the `build` directory.
200208
201-
202209
## Contributing
203210
204211
We welcome contributions to improve our documentation. Here are some guidelines:
@@ -215,4 +222,4 @@ For more detailed contributing guidelines, please see our [CONTRIBUTING.md](./CO
215222
216223
For more information on using Docusaurus, please refer to the [official Docusaurus documentation](https://docusaurus.io/docs).
217224
218-
Built with ❤️ by the CodeRabbit team
225+
Built with ❤️ by the CodeRabbit team

0 commit comments

Comments
 (0)