coderabbitai · hasit · Jul 15, 2024 · Jul 13, 2024 · Jul 15, 2024 · Jul 15, 2024
diff --git a/docs/guides/commands.md b/docs/guides/commands.md
@@ -4,7 +4,7 @@ sidebar_label: CodeRabbit Commands
 description:
   CodeRabbit offers various commands that can be invoked as PR comments to
   control the review process.
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 The following commands are available (invoked as PR comments):

diff --git a/docs/guides/delete-account.md b/docs/guides/delete-account.md
@@ -2,7 +2,7 @@
 title: Delete CodeRabbit Account
 sidebar_label: Delete CodeRabbit Account
 # description:
-sidebar_position: 3
+sidebar_position: 5
 ---
 
 The guide explains how to delete your CodeRabbit account and all the data

diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md
@@ -3,7 +3,7 @@ title: On-demand Reports
 sidebar_label: On-demand Reports (Beta)
 description:
   CodeRabbit offers a way to generate on-demand reports using a simple API request
-sidebar_position: 5
+sidebar_position: 6
 ---
 
 ```mdx-code-block
@@ -54,7 +54,6 @@ Sample output:
 ]
 ```
 
-
 :::info
 
 If you get a 401 UNAUTHORIZED error, check if you're passing the right API key in the `x-coderabbitai-api-key` header

diff --git a/docs/guides/review-instructions.md b/docs/guides/review-instructions.md
@@ -5,7 +5,7 @@ description:
   CodeRabbit offers various customization options to tailor the reviews to your
   specific requirements. Customizations can be made using one of the below
   options.
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 The guide explains how to add custom review instructions for the entire project.

diff --git a/docs/guides/tools/_category_.yml b/docs/guides/tools/_category_.yml
@@ -0,0 +1,4 @@
+label: Tools
+position: 2
+collapsible: true
+collapsed: true
diff --git a/docs/guides/tools/biome.md b/docs/guides/tools/biome.md
@@ -0,0 +1,198 @@
+---
+title: Biome
+sidebar_label: Biome
+description: CodeRabbit's guide to Biome.
+sidebar_position: 5
+---
+
+[Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS.
+
+## Files
+
+Biome will run on files with the following extensions:
+
+- `.js`
+- `.ts`
+- `.cjs`
+- `.mjs`
+- `.d.cts`
+- `.d.mts`
+- `.jsx`
+- `.tsx`
+- `.json`
+- `.jsonc`
+- `.css`
+
+## Configuration
+
+Biome supports the following config files:
+
+- `biome.jsonc`
+- `biome.json`
+
+CodeRabbit will use the following settings based on the profile selected if no config file is found:
+
+### Chill
+
+```json
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "organizeImports": {
+    "enabled": false
+  },
+  "formatter": {
+    "enabled": false
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "all": false,
+      "recommended": true,
+      "a11y": {
+        "recommended": false
+      },
+      "correctness": {
+        "useExhaustiveDependencies": "off",
+        "noInnerDeclarations": "off"
+      },
+      "style": {
+        "recommended": false,
+        "noArguments": "warn",
+        "noCommaOperator": "warn",
+        "noUselessElse": "warn",
+        "useAsConstAssertion": "off",
+        "useBlockStatements": "off",
+        "useConsistentArrayType": "off",
+        "useDefaultParameterLast": "warn",
+        "useEnumInitializers": "off",
+        "useExponentiationOperator": "warn",
+        "useExportType": "off",
+        "useFragmentSyntax": "off",
+        "useImportType": "off",
+        "useLiteralEnumMembers": "warn",
+        "useShorthandArrayType": "off",
+        "noUnusedTemplateLiteral": "off"
+      },
+      "complexity": {
+        "noForEach": "off",
+        "noExcessiveCognitiveComplexity": {
+          "level": "off",
+          "options": {
+            "maxAllowedComplexity": 25
+          }
+        },
+        "useLiteralKeys": "off",
+        "useArrowFunction": "off",
+        "useFlatMap": "off"
+      },
+      "suspicious": {
+        "noArrayIndexKey": "off",
+        "noExplicitAny": "off",
+        "noImplicitAnyLet": "off",
+        "noDoubleEquals": "off"
+      },
+      "nursery": {
+        "all": false
+      }
+    }
+  },
+  "css": {
+    "linter": {
+      "enabled": true
+    },
+    "parser": {
+      "cssModules": true
+    }
+  },
+  "javascript": {
+    "parser": {
+      "unsafeParameterDecoratorsEnabled": true
+    }
+  }
+}
+```
+
+### Assertive
+
+```json
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "organizeImports": {
+    "enabled": false
+  },
+  "formatter": {
+    "enabled": false
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "all": false,
+      "recommended": true,
+      "a11y": {
+        "recommended": ""
+      },
+      "correctness": {
+        "useExhaustiveDependencies": "off",
+        "noInnerDeclarations": "warn"
+      },
+      "style": {
+        "recommended": true,
+        "noArguments": "warn",
+        "noCommaOperator": "warn",
+        "noUselessElse": "warn",
+        "useAsConstAssertion": "off",
+        "useBlockStatements": "off",
+        "useConsistentArrayType": "off",
+        "useDefaultParameterLast": "warn",
+        "useEnumInitializers": "off",
+        "useExponentiationOperator": "warn",
+        "useExportType": "off",
+        "useFragmentSyntax": "off",
+        "useImportType": "off",
+        "useLiteralEnumMembers": "warn",
+        "useShorthandArrayType": "off",
+        "noUnusedTemplateLiteral": "off"
+      },
+      "complexity": {
+        "noForEach": "off",
+        "noExcessiveCognitiveComplexity": {
+          "level": "warn",
+          "options": {
+            "maxAllowedComplexity": 25
+          }
+        },
+        "useLiteralKeys": "off",
+        "useArrowFunction": "",
+        "useFlatMap": ""
+      },
+      "suspicious": {
+        "noArrayIndexKey": "",
+        "noExplicitAny": "",
+        "noImplicitAnyLet": "",
+        "noDoubleEquals": ""
+      },
+      "nursery": {
+        "all": false
+      }
+    }
+  },
+  "css": {
+    "linter": {
+      "enabled": true
+    },
+    "parser": {
+      "cssModules": true
+    }
+  },
+  "javascript": {
+    "parser": {
+      "unsafeParameterDecoratorsEnabled": true
+    }
+  }
+}
+
+```
+
+## Links
+
+- [Biome Configuration](https://biomejs.dev/reference/configuration/)
diff --git a/docs/guides/tools/golangci-lint.md b/docs/guides/tools/golangci-lint.md
@@ -0,0 +1,29 @@
+---
+title: golangci-lint
+sidebar_label: golangci-lint
+description: CodeRabbit's guide to golangci-lint.
+sidebar_position: 8
+---
+
+[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.
+
+## Files
+
+golangci-lint will run on files with the following extensions:
+
+- `.go`
+- `go.mod`
+
+## Configuration
+
+golangci-lint supports the following config files:
+
+- User-defined config file set at `reviews.tools.golangci-lint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → golangci-lint → Config File" field in CodeRabbit's settings page.
+- `.golangci.yml`
+- `.golangci.yaml`
+- `.golangci.toml`
+- `.golangci.json`
+
+## Links
+
+- [golangci-lint Configuration](https://golangci-lint.run/usage/configuration/)
diff --git a/docs/guides/tools/hadolint.md b/docs/guides/tools/hadolint.md
@@ -0,0 +1,42 @@
+---
+title: Hadolint
+sidebar_label: Hadolint
+description: CodeRabbit's guide to Hadolint.
+sidebar_position: 6
+---
+
+[Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter.
+
+## Files
+
+Hadolint will run on files with the following file names:
+
+- `Dockerfile`
+- `*.dockerfile`
+- `Dockerfile.*`
+
+## Configuration
+
+Hadolint supports the following config files:
+
+- `.hadolint.yaml`
+
+CodeRabbit will ignore the following severity levels if no config file is found:
+
+### Chill
+
+- `none`
+- `ignore`
+- `style`
+- `info`
+- `warning`
+
+### Assertive
+
+- `none`
+- `ignore`
+- `style`
+
+## Links
+
+- [Hadolint Configuration](https://github.com/hadolint/hadolint?tab=readme-ov-file#configure)
diff --git a/docs/guides/tools/languagetool.md b/docs/guides/tools/languagetool.md
@@ -0,0 +1,37 @@
+---
+title: LanguageTool
+sidebar_label: LanguageTool
+description: CodeRabbit's guide to LanguageTool.
+sidebar_position: 4
+---
+
+[LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker.
+
+## Files
+
+LanguageTool will run on files with the following extensions:
+
+- `.md`
+- `.mdx`
+- `.markdown`
+- `.txt`
+
+## Configuration
+
+LanguageTool's style and grammar check depends on the language selected in CodeRabbit's configuration. You can set the language by setting the `language` field in your project's `.coderabbit.yaml` file or setting the "Review Language" field in CodeRabbit's settings page.
+
+CodeRabbit allows further configuring LanguageTool by setting specific rules and categories to be enabled/disabled. This can be done under the `reviews.tools.languagetool` field in your project's `.coderabbit.yaml` file or setting the various options under "Review → Tools → LanguageTool" in CodeRabbit's settings page. The following options are available:
+
+- `enabled` - Enable or disable LanguageTool.
+- `enabled_rules` - Enable specific rules.
+- `disabled_rules` - Disable specific rules.
+- `enabled_categories` - Enable specific categories.
+- `disabled_categories` - Disable specific categories.
+- `enabled_only`- Enable only the rules and categories of IDs are specified with 'enabledRules' or 'enabledCategories'.
+- `level` - Set the level of feedback to be provided by LanguageTool. The following levels are available:
+  - `default` - Provides feedback on common issues.
+  - `picky` - Provides feedback on more issues, rules that you might only find useful when checking formal text.
+
+## Links
+
+- [LanguageTool Rules](https://community.languagetool.org/rule/list?lang=en)