Add LanguageTool documentation and configuration

hasit · hasit · commit 191e19e7e3ae · 2024-07-15T08:24:09.000-07:00
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: 3
+---
+
+[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)
diff --git a/docs/guides/tools/markdownlint.md b/docs/guides/tools/markdownlint.md
@@ -14,7 +14,7 @@ Markdownlint will run on files with the following extensions:
 - `.md`
 - `.markdown`
 
-## Settings
+## Configuration
 
 Markdownlint supports the following config files:
 
diff --git a/docs/guides/tools/ruff.md b/docs/guides/tools/ruff.md
@@ -13,7 +13,7 @@ Ruff will run on files with the following extensions:
 
 - `.py`
 
-## Settings
+## Configuration
 
 Ruff supports the following config files:
 
diff --git a/docs/guides/tools/shellcheck.md b/docs/guides/tools/shellcheck.md
@@ -16,7 +16,7 @@ ShellCheck will run on files with the following extensions:
 - `.ksh`
 - `.dash`
 
-## Settings
+## Configuration
 
 CodeRabbit will use the following settings based on the profile selected:
 
diff --git a/docs/guides/tools/tools.md b/docs/guides/tools/tools.md
