Add Yamllint documentation and configuration

hasit · hasit · commit 9d01dfe8bdad · 2024-07-15T10:01:43.000-07:00
diff --git a/docs/guides/tools/tools.md b/docs/guides/tools/tools.md
@@ -44,3 +44,5 @@ Remove extraneous f prefix
 - [Hadolint](./hadolint.md)
 - [SwiftLint](./swiftlint.md)
 - [PHPStan](./phpstan.md)
+- [golangci-lint](./golangci-lint.md)
+- [YamlLint](./yamllint.md)
diff --git a/docs/guides/tools/yamllint.md b/docs/guides/tools/yamllint.md
@@ -0,0 +1,46 @@
+---
+title: Yamllint
+sidebar_label: Yamllint
+description: CodeRabbit's guide to Yamllint.
+sidebar_position: 8
+---
+
+[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.
+
+## Files
+
+Yamllint will run on files with the following extensions:
+
+- `.yaml`
+- `.yml`
+
+## Configuration
+
+Yamllint supports the following config files:
+
+- `.yamllint`
+- `.yamllint.yaml`
+- `.yamllint.yml`
+
+CodeRabbit will use the following settings based on the profile selected if no config file is found:
+
+### Chill
+
+```yaml
+extends: relaxed
+rules:
+  line-length: disable
+```
+
+### Assertive
+
+```yaml
+extends: default
+rules:
+  line-length: disable
+  document-start: disable
+```
+
+## Links
+
+- [Yamllint Configuration](https://yamllint.readthedocs.io/en/stable/configuration.html)
