Add a config template file to the docs. (#410)

docs/getting-started/configure-coderabbit.md

@@ -34,8 +34,7 @@ configuration in a YAML format. You can then copy the configuration to a
 :::
 
 You can add a `.coderabbit.yaml` configuration file to the root of your
-repositories. Below is a sample YAML file that can be used as a starting point
-and changed as needed:
+repositories. For a complete sample `.coderabbit.yaml` file which you can add to your repository and update as needed, see [Configuration file template](/reference/yaml-template).
 
 Write your configuration file in the below editor to validate:
 

docs/reference/yaml-template.md

@@ -0,0 +1,184 @@
+---
+title: Configuration file template
+---
+
+You can use the following template as a basis for a new `.coderabbit.yaml` configuration file at the root level of your repository.
+
+If used as-is as a `.coderabbit.yaml` file, then this template sets the default, recommended values for [all CodeRabbit repository options](/reference/configuration). You can then update the values to best suit your team's code-review needs.
+
+For more information about using a `.coderabbit.yaml` file, see [Add a configuration file](/getting-started/configure-coderabbit).
+
+For a general overview of CodeRabbit configuration, see [Configure CodeRabbit](/guides/configuration-overview).
+
+```yaml
+# yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json
+
+language: en-US
+tone_instructions: ''
+early_access: true
+enable_free_tier: true
+reviews:
+  profile: chill
+  request_changes_workflow: false
+  high_level_summary: true
+  high_level_summary_placeholder: '@coderabbitai summary'
+  high_level_summary_in_walkthrough: false
+  auto_title_placeholder: '@coderabbitai'
+  auto_title_instructions: ''
+  review_status: true
+  commit_status: true
+  fail_commit_status: false
+  collapse_walkthrough: false
+  changed_files_summary: true
+  sequence_diagrams: true
+  assess_linked_issues: true
+  related_issues: true
+  related_prs: true
+  suggested_labels: true
+  auto_apply_labels: false
+  suggested_reviewers: true
+  auto_assign_reviewers: false
+  poem: true
+  labeling_instructions:
+    - label: ''
+      instructions: ''
+  path_filters: []
+  path_instructions:
+    - path: ''
+      instructions: ''
+  abort_on_close: true
+  disable_cache: false
+  auto_review:
+    enabled: true
+    auto_incremental_review: true
+    ignore_title_keywords: []
+    labels: []
+    drafts: false
+    base_branches: []
+  finishing_touches:
+    docstrings:
+      enabled: true
+    unit_tests:
+      enabled: true
+  tools:
+    ast-grep:
+      rule_dirs: []
+      util_dirs: []
+      essential_rules: true
+      packages: []
+    shellcheck:
+      enabled: true
+    ruff:
+      enabled: true
+    markdownlint:
+      enabled: true
+    github-checks:
+      enabled: true
+      timeout_ms: 90000
+    languagetool:
+      enabled: true
+      enabled_rules: []
+      disabled_rules: []
+      enabled_categories: []
+      disabled_categories: []
+      enabled_only: false
+      level: default
+    biome:
+      enabled: true
+    hadolint:
+      enabled: true
+    swiftlint:
+      enabled: true
+      config_file: ''
+    phpstan:
+      enabled: true
+      level: default
+    golangci-lint:
+      enabled: true
+      config_file: ''
+    yamllint:
+      enabled: true
+    gitleaks:
+      enabled: true
+    checkov:
+      enabled: true
+    detekt:
+      enabled: true
+      config_file: ''
+    eslint:
+      enabled: true
+    rubocop:
+      enabled: true
+    buf:
+      enabled: true
+    regal:
+      enabled: true
+    actionlint:
+      enabled: true
+    pmd:
+      enabled: true
+      config_file: ''
+    cppcheck:
+      enabled: true
+    semgrep:
+      enabled: true
+      config_file: ''
+    circleci:
+      enabled: true
+    clippy:
+      enabled: true
+    sqlfluff:
+      enabled: true
+    prismaLint:
+      enabled: true
+    pylint:
+      enabled: true
+    oxc:
+      enabled: true
+    shopifyThemeCheck:
+      enabled: true
+    luacheck:
+      enabled: true
+    brakeman:
+      enabled: true
+    dotenvLint:
+	 enabled: true
+    htmlhint: true
+      enabled: true
+      config_file: ''
+    checkmake:
+      enabled: true
+chat:
+  auto_reply: true
+  integrations:
+    jira:
+      usage: auto
+    linear:
+      usage: auto
+knowledge_base:
+  opt_out: false
+  web_search:
+    enabled: true
+  learnings:
+    scope: auto
+  issues:
+    scope: auto
+  jira:
+    usage: auto
+    project_keys: []
+  linear:
+    usage: auto
+    team_keys: []
+  pull_requests:
+    scope: auto
+code_generation:
+  docstrings:
+    language: en-US
+    path_instructions:
+      - path: ''
+        instructions: ''
+  unit_tests:
+    path_instructions:
+      - path: ''
+        instructions: ''
+```

sidebars.ts

@@ -167,6 +167,7 @@ const sidebars: SidebarsConfig = {
 				},
 				"reference/review-commands",
 				"reference/configuration",
+				"reference/yaml-template",
 				{
 					type: "category",
 					label: "Supported tools",