From e523ce95f0b9f641a907b6550548872f7b35da91 Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Wed, 9 Apr 2025 09:31:02 -0400 Subject: [PATCH 1/3] Clarify the need for Node.js and pnpm as prerequisites --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index de8e5ece..cf4c87e6 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,11 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co ## Getting Started +1. Make sure that you have the following prerequisites installed: + + - [Node.js](https://nodejs.org/) + - [pnpm](https://pnpm.io/installation) + 1. Clone this repository: ```sh From 6e179474b58b181ca9d053c4a7a5ea4f9d777f93 Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Wed, 9 Apr 2025 09:38:24 -0400 Subject: [PATCH 2/3] Clarify that the second installation step is specifically for Node.js dependencies --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cf4c87e6..0b05c3c2 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co cd coderabbit-docs ``` -2. Install dependencies: +2. Install Node.js dependencies using `pnpm`: ```sh pnpm install From 7f0b4d10ebad2195b06e5edb2e4230763675282c Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Wed, 9 Apr 2025 15:53:41 -0400 Subject: [PATCH 3/3] Replace tabs with spaces. Normalize ordered-list numbering. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0b05c3c2..8b5be0ac 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,8 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co 1. Make sure that you have the following prerequisites installed: - - [Node.js](https://nodejs.org/) - - [pnpm](https://pnpm.io/installation) + - [Node.js](https://nodejs.org/) + - [pnpm](https://pnpm.io/installation) 1. Clone this repository: @@ -49,13 +49,13 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co cd coderabbit-docs ``` -2. Install Node.js dependencies using `pnpm`: +1. Install Node.js dependencies using `pnpm`: ```sh pnpm install ``` -3. Start the development server: +1. Start the development server: ```sh pnpm start