diff --git a/README.md b/README.md index de8e5ece..bd76c6c5 100644 --- a/README.md +++ b/README.md @@ -37,20 +37,25 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co ## Getting Started -1. Clone this repository: +1. Make sure that you have the following prerequisites installed: + + - [Node.js](https://nodejs.org/) + - [pnpm](https://pnpm.io/installation) + +2. Clone this repository: ```sh git clone https://github.com/coderabbit-ai/coderabbit-docs.git cd coderabbit-docs ``` -2. Install dependencies: +3. Install Node.js dependencies using `pnpm`: ```sh pnpm install ``` -3. Start the development server: +4. Start the development server: ```sh pnpm start diff --git a/docs/platforms/bitbucket-cloud.md b/docs/platforms/bitbucket-cloud.md index 39015cdb..286321d5 100644 --- a/docs/platforms/bitbucket-cloud.md +++ b/docs/platforms/bitbucket-cloud.md @@ -18,9 +18,9 @@ This guide will assist you in effectively integrating CodeRabbit with Bitbucket To enable CodeRabbit to interact with your Bitbucket repositories, an app password is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs. 1. Create a new Bitbucket account specifically for CodeRabbit and treat it as a service account. -1. Name the account "CodeRabbit". -1. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this new account. -1. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories. +2. Name the account "CodeRabbit". +3. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this new account. +4. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories. We recommend creating a new user as a service account, associating this user to the workspace you'd like to install CodeRabbit on, and providing CodeRabbit with the app password to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.