👷 Add markdownlint pipeline (#125)

* 👷 Add markdownlint pipeline

* 🔧 Add CODEOWNERS file for TypeScript review assignments

* 🚨 Fix all markdownlint violations

* 💚 mailto

* 📝 Update changelog to reflect SOC 2 Type II compliance announcement

* 📝 Use canonical note admonition in semgrep

Author: NatoBoram

.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.json

@@ -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

.markdownlint.yaml

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

.markdownlintrc

@@ -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 git@github.com: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.

CHANGELOG.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
 ```
 

CONTRIBUTING.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.

README.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/Future Development.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/features.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: support@coderabbit.ai.
+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: [support@coderabbit.ai](mailto:support@coderabbit.ai).
 :::
 
 ## 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.