.review-docs.conf

# ══════════════════════════════════════════════════════════════════════════════
# Documentation Review Configuration
# ══════════════════════════════════════════════════════════════════════════════
#
# This file configures scripts/review-docs.py.
# Uncomment and modify values to customize check behavior.
#
# CLI flags (--disable, --only) override settings in this file.
# Use --no-config to ignore this file entirely.

[checks]
# Set each check to: error, warning, or disable
# Omitted checks use their built-in defaults (shown below).
#
# ── Prose checks (run on lines outside code blocks) ──
# heading-hierarchy = error
# heading-blank-line = warning
# trailing-whitespace = warning
# bare-urls = warning
# external-link-target = warning
# image-alt-text = warning
# product-names = warning
# banned-terms = warning
# admonition-capitalization = warning
# list-blank-line = warning
#
# ── Code block checks ──
# code-block-language = warning
# yaml-null-timestamps = warning
# yaml-flow-syntax = warning
# callout-format = warning
# yaml-validation = error
# callout-count = warning
#   Both auto-numbered (<.>) and manual callouts are accepted; mixing the
#   two styles in the same block is always invalid. To repeat a manual
#   marker, add the allow-duplicate-callouts attribute to the block, e.g.
#   [source,yaml,allow-duplicate-callouts] or
#   [source,yaml,allow-duplicate-callouts=true].
#
# ── Structural checks ──
# trailing-newline = warning
# tutorial-sections = warning
# nav-xrefs = error

[product-names]
# Case-sensitive product name corrections.
# Format: wrong = correct
# If this section is present and has entries, it replaces the built-in defaults.
# Built-in defaults:
#   Openshift = OpenShift
#   openshift = OpenShift

[banned-terms]
# Banned terminology with suggested replacements.
# Format: banned = replacement
# If this section is present and has entries, it replaces the built-in defaults.
# Built-in defaults:
#   k8s = Kubernetes