# Vale configuration for Coder documentation.

#

# Rule rollout doctrine. Every rule listed below ships clean: zero

# baseline findings across `docs/` (excluding `docs/.style/style-guide/`,

# which is exempt by design; see docs/.style/README.md) at enable time.

# Severity is a deliberate per-rule choice:

#

# - `error` top annotation tier; surfaces a GitHub `error`. Vale

# runs advisory, so it does not block merge today.

# - `warning` strong guidance; surfaces annotations without

# failing CI.

# - `suggestion` soft guidance; surfaces `notice` annotations.

#

# To add a rule, follow the per-rule PR template in

# docs/.style/README.md ("Adding a Vale rule"). Third-party rules

# from Google, alex, and write-good are not enabled by default; each

# returns via the same per-rule PR pattern after its corpus is clean.

#

# About Vale's exit code: Vale exits non-zero only when error-level

# alerts are found. Warning and suggestion annotate without

# affecting exit. Real runtime failures (bad config, missing files)

# propagate regardless of severity.

#

# The Coder rule package lives under docs/.style/styles/Coder/ and is

# the single source loaded by default.

StylesPath = docs/.style/styles

MinAlertLevel = suggestion

Vocab = Coder

[*.md]

BasedOnStyles = Coder

# Coder.OneSentencePerLine is rolled out per directory instead of repo-wide.

# The convention postdates most of the corpus, so enabling it everywhere would

# report roughly 2,200 findings and break the zero-baseline doctrine above.

# Move a directory into the allowlist below once its pages are converted.

Coder.OneSentencePerLine = NO

# Converted directories. The pages here are written one sentence per line, so

# the rule ships clean for this scope.

[docs/.style/*.md]

Coder.OneSentencePerLine = YES

[docs/.style/styles/Coder/*.md]

Coder.OneSentencePerLine = YES

# The style guide under docs/.style/style-guide/ deliberately demonstrates the

# violations the Coder rules ban (Don't examples in blockquotes and Do/Don't

# tables, banned terms named in headings and prose). Linting it would surface a

# standing backlog of intentional findings, which erodes trust in the annotation

# channel and breaks the zero-baseline doctrine. The rest of docs/.style/ (the

# landing page, content-guidelines.md, the annotation demo, and the Coder rule

# docs) is ordinary prose and stays linted; the annotation demo keeps firing its

# Coder.Demo* rules with no re-include. See docs/.style/README.md.

[docs/.style/style-guide/**]

BasedOnStyles =

Coder.OneSentencePerLine = NO