Merge branch 'main' into github-integration-guide

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{*.yaml,*.yml}]
+indent_style = space

.github/CODEOWNERS

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

.github/workflows/fix.yaml

@@ -0,0 +1,41 @@
+name: Fix
+
+on:
+  pull_request:
+    branches: main
+
+jobs:
+  fix:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+      - uses: pnpm/action-setup@v4
+        with:
+          version: latest
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+          cache: pnpm
+      - run: pnpm install
+      - run: pnpm run lint:fix
+
+      - id: diff
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            echo 'changes=true' >>"$GITHUB_OUTPUT"
+          fi
+
+      - if: steps.diff.outputs.changes == 'true'
+        name: Commit and push
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+
+          git commit --all --message '🎨 pnpm run lint:fix' --message '[dependabot skip]'
+          git push

.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

.gitignore

@@ -22,3 +22,6 @@ yarn-debug.log*
 yarn-error.log*
 package-lock.json
 yarn.lock
+
+# pnpm
+.pnpm-store

.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

.prettierignore

@@ -0,0 +1,6 @@
+.pnpm-store/
+build/
+dist/
+node_modules/
+package-lock.json
+pnpm-lock.yaml

.prettierrc.yaml

@@ -0,0 +1,4 @@
+arrowParens: avoid
+semi: false
+trailingComma: all
+useTabs: true

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	"recommendations": [
+		"davidanson.vscode-markdownlint",
+		"editorconfig.editorconfig",
+		"esbenp.prettier-vscode"
+	]
+}

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+	"[css][github-actions-workflow][html][javascript][javascriptreact][json][jsonc][markdown][postcss][scss][typescript][typescriptreact][yaml]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode",
+		"editor.minimap.maxColumn": 80,
+		"editor.rulers": [80]
+	},
+	"editor.codeActionsOnSave": {
+		"source.fixAll": "always",
+		"source.fixAll.markdownlint": "always",
+		"source.organizeImports": "always"
+	},
+	"editor.formatOnSave": true
+}

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

@@ -10,8 +10,9 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
 
 [![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/invite-code?color=7289DA&label=Discord&logo=discord&logoColor=green)](https://discord.com/invite/GsXnASn26c)
+[![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)
 
 ## 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
 ```
 

babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};
+	presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+}

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.
+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
+#### 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.