@@ -80,6 +80,25 @@ introduced, which is permanently true.
8080
8181- Use lowercase "config" in prose — ` vale.Terms ` flags a capital-C "Config"
8282
83+ ### Updating the vocabulary
84+
85+ If Vale flags a legitimate tech term, product name, or compound identifier
86+ as a misspelling, add it to ` _vale/config/vocabularies/Docker/accept.txt ` .
87+ This is optional — only update when a real new term is missing, not to
88+ silence individual violations.
89+
90+ - Use the canonical form for case-sensitive product names (` PyTorch ` ,
91+ ` GitHub ` , ` Kubernetes ` , ` BuildKit ` ). ` Vale.Terms ` enforces that exact
92+ case across the docs.
93+ - Use ` [Aa]bcd ` character-class regex for words that legitimately appear
94+ in multiple cases (e.g., sentence-starting capitalization, or a name
95+ that's also a generic noun). This covers spelling without enforcing
96+ a single canonical form.
97+ - Avoid broad regex patterns — entries that match many words at once
98+ (especially with ` (?i) ` ) suppress other rule checks on every match.
99+ - Don't add a wrong-cased entry to silence one false positive — it
100+ cascades into ` Vale.Terms ` violations on every correct usage.
101+
83102## Alpine.js patterns
84103
85104Do not combine Alpine's ` x-show ` with the HTML ` hidden ` attribute on the
@@ -111,12 +130,17 @@ produces broken HTML — always check COMPONENTS.md for correct syntax.
111130
112131``` sh
113132npx prettier --write < file> # Format before committing
133+ scripts/lint.sh < file> ... # Lint specific files (markdownlint + vale)
114134docker buildx bake validate # Run all validation checks
115135docker buildx bake lint # Markdown linting only
116136docker buildx bake vale # Style guide checks only
117137docker buildx bake test # HTML and link checking
118138```
119139
140+ For incremental work, prefer ` scripts/lint.sh ` over the ` bake ` targets —
141+ it runs the same checks on just the files you pass, so the output stays
142+ scoped to your changes instead of the whole repo.
143+
120144### Validation in git worktrees
121145
122146` docker buildx bake validate ` fails in git worktrees because Hugo cannot
@@ -128,9 +152,14 @@ and `validate-vendor` targets run correctly in CI.
128152
1291531 . Make changes
1301542 . Format with prettier: ` npx prettier --write <file> `
131- 3 . Run ` docker buildx bake lint vale `
155+ 3 . Lint the changed files: ` scripts/ lint.sh <file>... `
1321564 . Run a full build with ` docker buildx bake ` (optional for small changes)
133157
158+ Always lint the specific files you changed before committing. Use
159+ ` scripts/lint.sh ` rather than the ` bake ` targets so the output is scoped
160+ to your changes — bake runs across the entire repo and the noise makes
161+ real issues easy to miss.
162+
134163## Git hygiene
135164
136165- ** Stage files explicitly.** Never use ` git add . ` / ` git add -A ` /
0 commit comments