👷 Add markdownlint pipeline

.github/CODEOWNERS

@@ -0,0 +1 @@
+*.ts @coderabbitai/typescript-reviewers

.github/workflows/node.js.yaml

@@ -0,0 +1,24 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: latest
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile --strict-peer-dependencies
+      - run: pnpm run build
+      - run: pnpm run lint

.markdownlint-cli2.yaml

@@ -0,0 +1 @@
+gitignore: true

.markdownlint.yaml

@@ -0,0 +1,8 @@
+default: true
+first-line-heading: false
+line-length: false
+link-fragments: false
+no-duplicate-heading:
+  siblings_only: true
+no-inline-html: false
+single-title: false

CHANGELOG.md

@@ -0,0 +1 @@
+./docs/changelog.md

CONTRIBUTING.md

@@ -24,25 +24,30 @@ There are various ways you can contribute:
 
 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 [email protected]:YOUR_USERNAME/coderabbit-docs.git
 
+   ```
+
 3. Create a new branch:
-```shell
-git checkout -b your_username/feature_description
-```
+
+   ```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
-```
+
+   ```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]
@@ -52,7 +57,9 @@ This format is based on [Conventional Commits](https://www.conventionalcommits.o
 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
@@ -64,4 +71,4 @@ git rebase upstream/main
 - 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.
+- While AI is cool, minimize its use for _direct team communication_. We value concise, genuine exchanges over scripted messages.

README.md

@@ -12,6 +12,7 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
 [![Twitter Follow](https://img.shields.io/twitter/follow/coderabbitai?style=social)](https://twitter.com/coderabbitai)
 [![Discord](https://img.shields.io/discord/invite-code?color=7289DA&label=Discord&logo=discord&logoColor=green)](https://discord.com/invite/GsXnASn26c)
 [![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)
 
 ## About CodeRabbit
 
@@ -155,28 +156,28 @@ CodeRabbit uses the following order of precedence for configuration:
 
 1. Clone this repository:
 
-```bash
-git clone https://github.com/coderabbit-ai/coderabbit-docs.git
-cd coderabbit-docs
-```
+   ```sh
+   git clone https://github.com/coderabbit-ai/coderabbit-docs.git
+   cd coderabbit-docs
+   ```
 
 2. Install dependencies:
 
-```bash
-pnpm install
-```
+   ```sh
+   pnpm install
+   ```
 
 3. Start the development server:
 
-```bash
-pnpm start
-```
+   ```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.
+   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/
@@ -192,15 +193,15 @@ coderabbit-docs/
 
 ## Local Development
 
-```
+```sh
 docusaurus start
 ```
 
 This command starts a local development server and opens up a browser window.
 
 ## Building for Production
 
-```
+```sh
 docusaurus build
 ```
 

docs/Future Development.md

@@ -4,60 +4,60 @@ sidebar_label: Future Development
 description: Learn how CodeRabbit works in a pull request review.
 ---
 
-#  Future Developments
+# Future Developments
 
 We are actively iterating and refining CodeRabbit, and this is a sneak peek into the upcoming milestones and releases. We are focused on making the Applied AI review better than the median manual review. In addition to that, we are looking at a holistic user experience with various integrations and types of reviews.
 
-##  Applied AI Improvements
+## Applied AI Improvements
 
-We are actively trying to make the application of Generative AI more useful , relevant , meaningful for the coder and reviewer journey. Our immediate focus is 
+We are actively trying to make the application of Generative AI more useful , relevant , meaningful for the coder and reviewer journey. Our immediate focus is
 
-###  Accuracy and Conciseness Enhancements
+### Accuracy and Conciseness Enhancements
 
--  Refining knowledge base context understanding
--  Implementing advanced summarization techniques
--  Implementing a knowledge base feature library 
+- Refining knowledge base context understanding
+- Implementing advanced summarization techniques
+- Implementing a knowledge base feature library
 
 ### Learning Refinements
 
--  We have made significant improvement of the learning Enhancing reinforcement learning based on the user feedback
+- We have made significant improvement of the learning Enhancing reinforcement learning based on the user feedback
 
-##  New Feature Enhancements
+## New Feature Enhancements
 
-###  Expanded Integrations
+### Expanded Integrations
 
 We are integrating various tool chains to enable coders and reviewers to have a consistent experience irrespective of the tools. The immediate tools would be:
 
--  **Circle CI**
--  **Jenkins**
+- **Circle CI**
+- **Jenkins**
 
-###  Communication Tool Integrations
+### Communication Tool Integrations
 
 Communication and the user experience of review via various communication tools are going to be key. We will start with integrations to Slack and Microsoft Teams and will be diving into the design engineering of these flows further:
 
--  **Slack**: Real-time notifications and interactive discussions
--  **Microsoft Teams**: Code review conversations within Microsoft ecosystem
+- **Slack**: Real-time notifications and interactive discussions
+- **Microsoft Teams**: Code review conversations within Microsoft ecosystem
 
-###  Enhanced Review Capabilities
+### Enhanced Review Capabilities
 
 These are additional capabilities that can also be reviewed in the same PR to accelerate the coder and reviewer journey. This includes pipeline failure analysis and resolution, as well as vulnerability assessment.
 
-####  Pipeline Failure Analysis
+#### Pipeline Failure Analysis
 
 - Automated analysis of CI/CD pipeline failures
 - AI-driven suggestions for resolving issues
 - Historical tracking of pipeline performance
 
-###  Finishing Touches
+### Finishing Touches
 
  Finishing touches are about experience that often take developers time away from what they like doing best - coding. But adding finishing touches is crucial and should follow the ontology and taxonomy. We will start by looking into Docstring and expand to various areas to solve pain points for coders and reviewers.
 
 #### 1.  DocString Review
 
--  Automated checks for docstring presence and quality
--  AI-powered suggestions for improving documentation
--  Resolving Doc-string conflicts in a following PR
+- Automated checks for docstring presence and quality
+- AI-powered suggestions for improving documentation
+- Resolving Doc-string conflicts in a following PR
 
-> Disclaimer: any product roadmap features mentioned below are only meant to outline 
-> our general product direction. This documentation is for informational purposes 
+> Disclaimer: any product roadmap features mentioned below are only meant to outline
+> our general product direction. This documentation is for informational purposes
 > only and may not be incorporated into any contract.

docs/about/features.md

@@ -24,7 +24,7 @@ changes.
 ### 2. Code Review feedback {#code-review-feedback}
 
 **Code review** feedback is posted as review comments on the lines of the code that
-changed for each file. 
+changed for each file.
 
 > Code suggestions are given in a Diff format, which either
 be copied or committed within the pull request with a single click.
@@ -85,7 +85,7 @@ changes.
 ### 7. Learnings {#learnings}
 
 - **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your
-repositories and organization. 
+repositories and organization.
 - **CodeRabbit** will apply and update these learnings
 in future reviews.
 

docs/about/pricing.md

@@ -22,6 +22,7 @@ Find all the information you need about CodeRabbit's plans and how to manage you
 ---
 
 ## Open Source
+
 :::note
 CodeRabbit Pro is free for all Open Source projects.
 :::

docs/about/support.md

@@ -8,7 +8,7 @@ Welcome to CodeRabbit Support. Please refer to the following sections for
 contacting our support team. Our support team will respond back as soon as
 possible.
 
-## Discord Server 
+## Discord Server
 
 All CodeRabbit users have access to the [CodeRabbit Discord Server](http://discord.gg/coderabbit), where you can ask questions or see what others are doing with CodeRabbit. You will find CodeRabbit users and members of the CodeRabbit team actively engaged.
 
@@ -20,24 +20,24 @@ For assistance from our support team, click the help icon located in the bottom
 
 Complete the support ticket by providing your name, email, a description of your issue, and attaching any necessary files. If you are reporting a bug, please provide the GitHub or GitLab organization name.
 
-
 ![How to Open a Support Ticket-CodeRabbit ](/img/about/cr_support_help_light.png#gh-light-mode-only)
 ![How to Open a Support Ticket-CodeRabbit ](/img/about/cr_support_help_dark.png#gh-dark-mode-only)
 
 :::note
-If you are a paying user and cannot access the support ticket form in the CodeRabbit UI for some reason, you can contact CodeRabbit support at the following email address: [email protected].
+If you are a paying user and cannot access the support ticket form in the CodeRabbit UI for some reason, you can contact CodeRabbit support at the following email address: [[email protected]](mailto:[email protected]).
 :::
 
 ## Customer Responsibilities
 
-> To ensure efficient resolution of issues, customers are expected to 
+> To ensure efficient resolution of issues, customers are expected to
 
 1. Provide detailed information about the issue.
 2. Cooperate with the Support team during troubleshooting.
 3. Utilize available self-service resources/docs for basic inquiries.
 
 ## Etiquette
-Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language. 
+
+Regardless of the method or location through which CodeRabbit provides Support, communication should be professional and respectful. Any communication that is deemed objectionable by CodeRabbit staff is not tolerated. This includes but is not limited to any communication that is abusive or contains profane language.
 
 > CodeRabbit reserves the right to terminate Support Services in the event of any such objectionable communication.
 

docs/changelog.md

@@ -6,17 +6,17 @@ sidebar_position: 9
 ---
 
 ## October 30, 2024
-###  Microsoft Teams Integration & Bitbucket Support
 
-Our integration capabilities just got a major upgrade with Microsoft Teams and Bitbucket support.
-
-- Microsoft Teams integration is with scheduled reporting system and direct notification pipeline to keep your team informed. 
+### Microsoft Teams Integration & Bitbucket Support
 
-- We've also launched  Bitbucket Data Center support with Pull Request integration, offering core review functionality, Pull Request summaries, and direct inline comments for applying review suggestions
+Our integration capabilities just got a major upgrade with Microsoft Teams and Bitbucket support.
 
+- Microsoft Teams integration is with scheduled reporting system and direct notification pipeline to keep your team informed.
 
+- We've also launched Bitbucket Data Center support with Pull Request integration, offering core review functionality, Pull Request summaries, and direct inline comments for applying review suggestions
 
 ## October 22, 2024
+
 ### Security and SAST Remediation Improvements
 
 - Enabling comprehensive security analysis directly from context within GitHub Checks
@@ -26,6 +26,7 @@ Our integration capabilities just got a major upgrade with Microsoft Teams and B
 - CodeRabbit now automatically detects Semgrep rulesets from default `semgrep.yml` or `semgrep.config.yml` files, eliminating the need for manual configuration
 
 ## September 9, 2024
+
 ### Related PRs and Label suggestions
 
 - Possibly related PRs: The walkthrough comment now includes a list of potentially related PRs to help you recall the past context
@@ -34,11 +35,13 @@ Our integration capabilities just got a major upgrade with Microsoft Teams and B
 > Note: Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).
 
 ## August 15, 2024
-### New Dashboard 
+
+### New Dashboard
 
 We're excited to share our updated dashboard, designed to give you better insights into CodeRabbit review metrics.
 
 What's new:
+
 - Flexible Time Selector: Choose different periods to analyze your data
 - Useful Context: See how learnings, tools, and path instructions are used in reviews
 - New Visuals: Check out the bar, line, and stats charts for a better understanding
@@ -48,11 +51,13 @@ What's new:
 These updates are here to help you get more from the dashboard. Take a look today!
 
 ## July 31, 2024
+
 ### Promote members to admin
 
 You can now promote members in your organization to admins within CodeRabbit. Admins will be able to manage the subscription and the seats for that organization.
 
 ## July 16, 2024
+
 ### New Features and Improvements
 
 #### Learnings Page
@@ -62,6 +67,7 @@ We're thrilled to announce the new "Learnings" page! Users can now interact with
 #### Reports (Beta) Page
 
 Introducing the beta release of "Reports"! Generate recurring summaries of team performance and PR reviews with features like:
+
 - Scheduling regular report generation
 - Specifying parameters such as repository, team, user, or label
 - Selecting report types (Daily Stand-Up, Sprint Report, Release Notes, Custom)
@@ -74,6 +80,7 @@ You can now choose whether to auto-generate sequence diagrams in PR Walkthroughs
 #### Enhanced Tool Settings & New Analysis Tools
 
 We've refined the default settings to be less noisy and more actionable. Additionally, we've added new static analysis and security tools:
+
 - Yamllint A linter for YAML files
 - Gitleaks A lightweight, open-source secret scanner to prevent security breaches
 - Checkov Scans infrastructure as code for misconfigurations before they become security issues
@@ -83,79 +90,99 @@ We've refined the default settings to be less noisy and more actionable. Additio
 The GitLab integration now offers more flexibility and security. Users can use Personal Access Tokens (PATs) from within their organization to post reviews. This enhancement ensures reviews are posted with appropriate organizational context and permissions, improving traceability and security.
 
 ## May 28, 2024
+
 ### New Features and Improvements
 
 #### Sequence Diagrams
+
 CodeRabbit now generates sequence diagrams of code changes, enhancing reviewers' ability to understand the flow of control.
 
 #### Auto-Generate PR Titles
+
 Users will now find a new option called auto_title_placeholder and will default to `@coderabbitai` title. This option allows users to put a placeholder title and have CodeRabbit auto-generate one for them when the review process kicks in.
 
 #### New Commands
+
 We have introduced new commands for interacting with CodeRabbit, detailed under the "Tips" section of a review walkthrough:
+
 - `@coderabbitai full review`: Conducts a full review from scratch, covering all files again
 - `@coderabbitai summary`: Regenerates the summary of the PR
 - `@coderabbitai configuration`: Displays the current CodeRabbit configuration for the repository
 
 #### Improved Handling of Closed PRs
+
 We have been observing that many PRs get closed quickly and CodeRabbit continues to review them. PRs get closed quickly for various reasons - changes are too small, the author is confident (perhaps, overly?), or the changes were unnecessary. With this improvement, we now stop the review process midway if we detect that the PR has been closed.
 
 ## May 23, 2024
+
 ### New Features and Improvements
 
 #### Review Settings
+
 Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.
 
 #### More Static Analysis Support
+
 We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.
 
 #### Tone Settings
+
 Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
+
 - Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
 - Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
 - Snarky Ex-Girlfriend: "You must talk like a snarky ex-girlfriend in all your code reviews. You're welcome."
 
 #### Revamped Settings Page
+
 We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long-time coming; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.
 
 ## April 18, 2024
+
 ### Static Analyzers and Linters Integration
 
 CodeRabbit now runs static analyzers, linters and provides one-click fixes for the issues identified. AI helps reduce the false positives and focus on the critical findings. CodeRabbit will respect the existing configuration files of these tools if they already exist in the project. For example, if your project already uses ruff and has a ruff.toml file at the root of the project, that will be used. In cases where project configurations are not found, CodeRabbit defaults will be used. Currently, CodeRabbit runs markdownlint, shellcheck, ruff, and languagetool. We will continue to add more tools. The default configuration can be changed through the .coderabbit.yaml file.
 
 Are there any specific tools you'd like us to add? Let us know. We'd love to hear your suggestions!
 
 ## April 1, 2024
+
 ### GDPR Compliance
 
 Excited to announce that CodeRabbit is now GDPR compliant in accordance with EU regulations!
 
 ## March 12, 2024
+
 ### GitHub Check Fixes
 
 CodeRabbit now offers fixes for GitHub Check failures on pull requests. With this change, Check Runs on GitHub that add Annotations to Pull Requests will be used. For example, popular GitHub Actions published by reviewdog (action-golangci-lint, action-staticcheck, action-eslint) and super-linter among many others have the ability to report issues on Pull Requests as annotations. Checks that output logs will be supported shortly. CodeRabbit GitHub App requires permission to read Checks for this feature to work. To enable this, please grant the necessary permissions by visiting the CodeRabbit GitHub app settings under [installation](https://github.com/settings/installations). Support for GitLab will follow.
 
 ## March 11, 2024
+
 ### SOC 2 Type II Compliance
 
 Excited to announce that CodeRabbit is now GDPR compliant in accordance with EU regulations!
 
 ## March 2, 2024
+
 ### Enhanced Markdown Review
 
 CodeRabbit now offers a more comprehensive review of the markdown changes. In addition to the AI suggestions, we do a thorough check for spelling, grammar, word choice, language style, as well as improvements in paraphrasing and punctuation.
 
 ## January 17, 2024
+
 ### Self-hosted GitLab Integration
 
 CodeRabbit now offers integration for self-hosted GitLab. Refer to the [setup instructions](https://docs.coderabbit.ai/integrations/self-hosted-gitlab).
 
 ## January 2, 2024
+
 ### Deep Insights Feature Release
 
 Working as recursive autonomous agent, CodeRabbit uses shell scripts to perform complex operations on the entire codebase, verifying changes and providing deeper insights.
 
 Here are some uses cases:
+
 - Want to defer implementing the CodeRabbit suggestion to a later time? Ask the bot the create an issue
 - Generate unit tests - comment `@coderabbitai generate unit tests` for the src/utils.ts
 - In PR comments, ask the bot to gather insights on your repository including latest commits, frequently changed files, recent contributors etc
@@ -164,73 +191,88 @@ Here are some uses cases:
 Really excited to see how this feature gets used, especially with access to the CLI commands. There are some suggestions in the pull request tips but we are looking forward to seeing additional use cases of how developers use this feature. Please consider sharing your experiences.
 
 ## December 18, 2023
+
 ### Request Changes Workflow
 
 Enable Request Changes review workflow for CodeRabbit reviews via .coderabbit.yaml Yaml field request_changes_workflow (default: false). When enabled, review comments are posted as request changes and CodeRabbit review will be marked approved once all the review comments are resolved.
 
 ## December 5, 2023
+
 ### Multiple Features Release
 
 #### Learnings
+
 CodeRabbit can now learn from your conversations to fine-tune your reviews. If you encounter inaccurate feedback or something not relevant to your codebase, just let the bot know, and it will remember the context for the future. We understand that coding practices and standards evolve over time. Using the chat, you can inform the bot, and it will remove any existing learnings that are no longer relevant. This feature does not work, if you have opted out of data storage.
 
 #### Codebase Verification
+
 Verifies the reference of the changes on the overall codebase and identifies missing changes.
 
 #### Jira and Linear Integrations
+
 You can now integrate Jira and Linear into CodeRabbit. This would be used for additional context while reviewing pull requests. If you use any of these systems, we recommend you integrate CodeRabbit. We will be adding more integrations over time.
 
 #### Related Issues
+
 Identifies all issues affected by the code changes. This helps understand the impact on the overall product. It also assists in identifying duplicate issues or the impact on any other existing issues. This feature does not work, if you have opted out of data.
 
 ## November 5, 2023
+
 ### Issue Validation
 
 CodeRabbit review can now assess the pull request changes against the linked GitHub or GitLab issue. Integration with other workflow systems including Jira and Linear is under development.
 
 ## November 1, 2023
+
 ### Committable Suggestions
 
 Review comments can now post committable suggestions that can be committed within the pull request with a single click.
 
 ## October 28, 2023
+
 ### Resolve Command
 
 Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once.
 
 ## October 23, 2023
+
 ### CodeRabbit Commands
 
 Introducing additional CodeRabbit commands for managing code reviews:
+
 - Pause Reviews: Use `@coderabbitai pause` in a PR comment to halt ongoing reviews
 - Resume Reviews: Enter `@coderabbitai resume` in a PR comment to continue paused reviews
 - On-Demand Reviews: Disable automatic reviews for your repository to switch to on-demand reviews. Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review
 - Help Command: You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands
 
 ## October 12, 2023
+
 ### YML File Customization
 
 CodeRabbit customizations made easy! You can now customize CodeRabbit using a YML file from your repository. To learn more, refer to our comprehensive documentation on customizing CodeRabbit.
 
 ## September 21, 2023
+
 ### Path-Based Review Instructions
 
 This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers can provide tailored review guidelines based on the file paths. These instructions are needed only if you want the reviewer to follow specific instructions besides the standard review.
 
 Adding file path prompts allows developers to specify custom instructions for different parts of the codebase. For example, you may want to enforce style guide by file types or directories.
 
 Sample Usage:
-```
+
+```yaml
 path: **/*.js
 instructions: Review the javascript code against the google javascript style guide and point out any mismatches
 ```
 
-```
+```yaml
 path: tests/**.*
 instructions: Review the following unit test code written using the Mocha test library. Ensure that: The code adheres to best practices associated with Mocha. Descriptive test names are used to clearly convey the intent of each test.
 ```
 
 > Note:
+>
 > - Paths accept glob patterns
 > - Instructions generally work well for specific additional instructions. However, they are not that effective if you are instructing AI not to do something
 > - Test the review feedback on pull requests and tailor as necessary

docs/guides/review-instructions.md

@@ -17,7 +17,7 @@ This section explains how to add custom code review instructions for the entire
 project or specific file paths in your project using glob patterns. Developers
 can provide tailored review guidelines based on the file paths. These
 instructions are needed only if you want CodeRabbit to follow specific
-instructions besides the standard review. 
+instructions besides the standard review.
 
 >For example, you may want to enforce a style guide by file types or directories.
 

docs/introduction.md

@@ -52,12 +52,12 @@ However, opting out may reduce the level of personalized review feedback.
 
 :::tip
 For open source projects CodeRabbit Pro is **_FREE_**, forever.
+
 - No credit card required
 - Unlimited public repositories
+
 :::
 
 <div style={{textAlign: 'left', marginTop: '20px'}}>
   <a href="https://app.coderabbit.ai/login" className="button button--primary button--lg">Start reviewing PR Now</a>
 </div>
-
-

docs/platforms/azure-devops.md

@@ -21,14 +21,14 @@ DevOps.
    consent requests. Please forward these requests to your administrator for
    approval.
 
-:::warning
+   :::warning
 
-If you are an administrator, you may approve the applications directly. If not,
-please contact your administrator to request approval for the applications.
+   If you are an administrator, you may approve the applications directly. If not,
+   please contact your administrator to request approval for the applications.
 
-:::
+   :::
 
-![azure devops apps consent](/img/integrations/azure_apps_consent_page.png)
+   ![azure devops apps consent](/img/integrations/azure_apps_consent_page.png)
 
 3. Once your administrator has approved the applications, click "Continue."
 4. You will be redirected to the "Onboarding" page, where you can select the

docs/tools/semgrep.md

@@ -22,13 +22,11 @@ Semgrep supports the following config files:
   project's `.coderabbit.yaml` file or setting the "Review → Tools → Semgrep →
   Config File" field in CodeRabbit's settings page.
 
-> Due to licensing CodeRabbit does not ship with the
-> [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules),
-> but you're free to use these in your own `semgrep.yml` config file.
+Due to licensing, CodeRabbit does not ship with the [community-created Semgrep rules](https://github.com/returntocorp/semgrep-rules), but you're free to use these in your own `semgrep.yml` config file.
 
-> **NOTE: CodeRabbit will only run Semgrep if your repository contains a Semgrep
+> **NOTE:** CodeRabbit will only run Semgrep if your repository contains a Semgrep
 > config file. This config must use the default file names or you must define
-> the path to this file in the `.coderabbit.yaml` or config UI.**
+> the path to this file in the `.coderabbit.yaml` or config UI.\*\*
 
 ## Links
 

docs/tools/tools.md

@@ -89,4 +89,3 @@ Remove extraneous f prefix
 [Cppcheck]: ./cppcheck.md
 [CircleCi]: ./circleci.md
 [Semgrep]: ./semgrep.md
-

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "coderabbit-docs",
+  "name": "@coderabbitai/coderabbit-docs",
   "version": "0.0.0",
   "private": true,
   "scripts": {
@@ -10,9 +10,11 @@
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
+    "lint": "markdownlint-cli2 \"**/*.md\"",
+    "lint:fix": "markdownlint-cli2 \"**/*.md\" --fix",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@docusaurus/core": "^3.1.1",
@@ -32,14 +34,19 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^3.1.1",
+    "@docusaurus/theme-classic": "^3.5.2",
     "@docusaurus/tsconfig": "^3.1.1",
     "@docusaurus/types": "^3.1.1",
     "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.8.4",
     "@types/react": "^18.3.4",
     "ace-builds": "^1.36.1",
     "ajv": "^8.17.1",
     "js-yaml": "^4.1.0",
+    "markdownlint-cli2": "^0.14.0",
+    "prettier": "^3.3.3",
     "react": "^18.3.1",
+    "sitemap": "^8.0.0",
     "typescript": "~5.2.2"
   },
   "browserslist": {