coderabbitai · behicof · Jul 9, 2025 · Jul 9, 2025 · Jul 9, 2025 · Jul 9, 2025
diff --git a/.ipynb_checkpoints/CONTRIBUTING-checkpoint.md b/.ipynb_checkpoints/CONTRIBUTING-checkpoint.md
@@ -0,0 +1,74 @@
+# Contributing Guide to CodeRabbit Documentation
+
+Welcome, and thank you for considering contributing to the **CodeRabbit Documentation**. This guide will help you get started and ensure a smooth contribution process.
+
+## Before You Start ✋
+
+The CodeRabbit documentation repository is an open-source project aimed at creating clear, detailed, and developer-friendly documentation for CodeRabbit. Whether you're improving existing docs or adding new content, your contributions are valued.
+
+## How Can I Contribute?
+
+There are various ways you can contribute:
+
+- **Fixing Typos or Improving Grammar**: Even small fixes like spelling errors or improving sentence structure are appreciated.
+- **Clarifying Existing Documentation**: If something is unclear, feel free to rewrite for better understanding and give a clear explanation in PR.
+- **Suggesting Structural Improvements**: Propose changes that can improve the structure and navigation of the docs.
+
+### Join the Community
+
+- Connect with other contributors by joining our [CodeRabbit Discord Server](https://discord.gg/coderabbit). Feel free to introduce yourself in the `#intros` channel.
+
+## How to Contribute? 👨‍💻
+
+### Fork and Pull Request Flow ⏳
+
+1. **Fork** the repository to your GitHub account by visiting [CodeRabbit Docs GitHub repo](https://github.com/coderabbitai/coderabbit-docs).
+2. **Clone** your fork locally:
+
+   ```shell
+   git clone git@github.com:YOUR_USERNAME/coderabbit-docs.git
+
+   ```
+
+3. Create a new branch:
+
+   ```shell
+   git checkout -b your_username/feature_description
+   ```
+
+4. Implement the changes then commit and push the changes from your working branch:
+
+   ```shell
+   git commit -m "docs: add explanation about [section]"
+   git push origin your_username/feature_description
+   ```
+
+## Commit Message Format 💬
+
+We require all commits in this repository to adhere to the following commit message format.
+
+```txt
+<type>: <description> (#<issue number>)
+
+[optional body]
+```
+
+This format is based on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+Please refer to the Conventional Commits specification for more details.
+
+## Keeping your Fork Up-to-Date 🆕
+
+To keep your fork updated with the latest changes from the upstream repository:
+
+```shell
+git remote add upstream https://github.com/coderabbitai/coderabbit-docs.git
+git fetch upstream
+git rebase upstream/main
+```
+
+## Contributing Best Practices 🚨
+
+- Work on **one issue at a time** to avoid confusion.
+- If you need help, post in the `#support` channel on Discord.
+- Test your changes locally before submitting a PR.
+- While AI is cool, minimize its use for _direct team communication_. We value concise, genuine exchanges over scripted messages.
diff --git a/.ipynb_checkpoints/README-checkpoint.md b/.ipynb_checkpoints/README-checkpoint.md
@@ -0,0 +1,114 @@
+<p align="left">
+  <a href="https://coderabbit.ai">
+    <img src="static/img/coderabbit_nav_logo.svg" alt="CodeRabbit Logo" width="200"/>
+  </a>
+</p>
+
+# CodeRabbit Documentation
+
+Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the code review dev tool that helps you ship quality code faster.
+
+[![Website](https://img.shields.io/badge/website-coderabbit.ai-blue)](https://coderabbit.ai)
+[![Twitter Follow](https://img.shields.io/twitter/follow/coderabbitai?style=social)](https://twitter.com/coderabbitai)
+[![Discord](https://img.shields.io/discord/1134356397673414807?color=7289DA&label=Discord&logo=discord&logoColor=green)](http://discord.gg/coderabbit)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/coderabbitai/coderabbit-docs/pulls)
+[![Node.js CI](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml/badge.svg)](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/coderabbitai/coderabbit-docs?labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit%20Reviews)
+
+## About CodeRabbit
+
+> **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
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Project Structure](#project-structure)
+- [Local Development](#local-development)
+- [Building for Production](#building-for-production)
+- [Contributing](#contributing)
+
+## Getting Started
+
+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
+   ```
+
+3. Install Node.js dependencies using `pnpm`:
+
+   ```sh
+   pnpm install
+   ```
+
+4. Start the development server:
+
+   ```sh
+   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.
+
+## Project Structure
+
+```sh
+coderabbit-docs/
+  ├── blog/
+  ├── docs/
+  ├── src/
+  │   ├── components/
+  │   ├── css/
+  │   └── pages/
+  ├── static/
+  ├── docusaurus.config.ts
+  ├── sidebar.ts
+  └── package.json
+```
+
+## Local Development
+
+```sh
+docusaurus start
+```
+
+This command starts a local development server and opens up a browser window.
+
+## Building for Production
+
+```sh
+docusaurus build
+```
+
+This command generates static content into the `build` directory.
+
+## Contributing
+
+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 our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
+
+---
+
+For more information on using Docusaurus, please refer to the [official Docusaurus documentation](https://docusaurus.io/docs).
+
+Built with ❤️ by the CodeRabbit team
diff --git a/.ipynb_checkpoints/babel.config-checkpoint.js b/.ipynb_checkpoints/babel.config-checkpoint.js
@@ -0,0 +1,3 @@
+module.exports = {
+	presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+}