forked from coder/coder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.vale.ini
More file actions
42 lines (39 loc) · 1.92 KB
/
Copy path.vale.ini
File metadata and controls
42 lines (39 loc) · 1.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 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
[*.md]
BasedOnStyles = Coder
# 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 =