docs(ci): vale accept-list for domain terms; drop dead duplicate (bo-lzik)#29
Merged
Conversation
…lzik) The Docs workflow runs Vale across all docs/book/src files on any doc change, so domain-term spelling false-positives in unrelated files failed Style check on every docs PR (e.g. #24/bo-qlfu had to be merged past a red check). - Add the 14 flagged domain terms to the canonical accept-list (.vale/styles/config/vocabularies/Bobbin/accept.txt): async, changeset, changesets, Clippy, commit, exclude_tag, knowledge_context, knowledge_query, kota, Quipu, reactively, rebase, upserted. Verified `vale --minAlertLevel error docs/book/src/` → 0 errors across 75 files (vale 3.13.1, as CI uses). - Remove the dead .vale/styles/Vocab/Bobbin/accept.txt — Vale 3.x reads config/vocabularies/, not the v2 Vocab/ path, so that file was vestigial and invited edits to the wrong list (the recurring-confusion root cause). - Document the accept-list location + how to find flagged terms in contributing.md; fix the stale Vocab/ path in documentation-strategy.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YGrLvUVZAc383ZBpRhK86f
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The Docs workflow runs Vale (
Style check) across alldocs/book/src/files on any doc change, so domain-term spelling false-positives in files unrelated to a PR turned the check red on every docs PR — e.g. #24 (bo-qlfu) had to be merged past a red Style check.What
.vale/styles/config/vocabularies/Bobbin/accept.txt):async,changeset,changesets,Clippy,commit,exclude_tag,knowledge_context,knowledge_query,kota,Quipu,reactively,rebase,upserted..vale/styles/Vocab/Bobbin/accept.txt. Vale 3.x readsconfig/vocabularies/, not the v2Vocab/path — that file was vestigial and invited edits to the wrong list (the recurring-confusion root cause).contributing.md; fix the staleVocab/path indocumentation-strategy.md.Verification
Ran the exact CI tool (vale 3.13.1):
Confirmed lowercase entries are case-insensitive (
asynccoversAsync), so no redundant capitalized variants were added. markdownlint: code fences carry languages (MD040),docs/plans/**is in the lint ignore list.Closes bo-lzik.