Repository files navigation

Welcome to the official docs forCodeRabbit, the code review dev tool that helps you ship quality code faster.

CodeRabbit is an AI-powered code reviewer that delivers context-aware feedback on pull requests within minutes, reducing the time and effort needed for manual code reviews. It provides a fresh perspective and catches issues that are often missed, enhancing the overall review quality.

• Automated code reviews
• Intelligent suggestions for code improvements
• Pull request summary
• Interactive chat
• Sequence diagrams
• Integration with popular version control platforms
• Support for all programming languages

• Getting Started
• Project Structure
• Local Development
• Building for Production
• Contributing

1. Make sure that you have the following prerequisites installed:

   • Node.js
   • pnpm

2. Clone this repository:

   git clone https://github.com/coderabbit-ai/coderabbit-docs.gitcd coderabbit-docs

3. Install Node.js dependencies usingpnpm:

   pnpm install

4. Start the development server:

   pnpm start

   This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

coderabbit-docs/  ├── blog/  ├── docs/  ├── src/  │   ├── components/  │   ├── css/  │   └── pages/  ├── static/  ├── docusaurus.config.ts  ├── sidebar.ts  └── package.json

docusaurus start

This command starts a local development server and opens up a browser window.

docusaurus build

This command generates static content into thebuild directory.

We welcome contributions to improve our documentation. Here are some guidelines:

1. Fork this repository
2. Create a new branch for your changes
3. Make all the changes
4. Test your changes locally
5. Submit a pull request with a clear description of what changes you did and why.

For more detailed contributing guidelines, please see ourCONTRIBUTING.md file.

For more information on using Docusaurus, please refer to theofficial Docusaurus documentation.

Built with ❤️ by the CodeRabbit team