Skip to content

docs(ci): vale accept-list for domain terms; drop dead duplicate (bo-lzik)#29

Merged
scbrown merged 1 commit into
mainfrom
bo-lzik-vale-accept-list
Jun 28, 2026
Merged

docs(ci): vale accept-list for domain terms; drop dead duplicate (bo-lzik)#29
scbrown merged 1 commit into
mainfrom
bo-lzik-vale-accept-list

Conversation

@scbrown

@scbrown scbrown commented Jun 28, 2026

Copy link
Copy Markdown
Owner

Why

The Docs workflow runs Vale (Style check) across all docs/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

  • Whitelist the 14 flagged domain terms in 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.
  • Remove the dead duplicate .vale/styles/Vocab/Bobbin/accept.txt. Vale 3.x reads config/vocabularies/, not the v2 Vocab/ path — that file was vestigial and invited edits to the wrong list (the recurring-confusion root cause).
  • Document the accept-list location and how to find flagged terms locally in contributing.md; fix the stale Vocab/ path in documentation-strategy.md.

Verification

Ran the exact CI tool (vale 3.13.1):

vale sync
vale --minAlertLevel error docs/book/src/
✔ 0 errors, 0 warnings and 0 suggestions in 75 files.

Confirmed lowercase entries are case-insensitive (async covers Async), so no redundant capitalized variants were added. markdownlint: code fences carry languages (MD040), docs/plans/** is in the lint ignore list.

Closes bo-lzik.

…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
@scbrown
scbrown merged commit 2cfceee into main Jun 28, 2026
5 checks passed
@scbrown
scbrown deleted the bo-lzik-vale-accept-list branch June 28, 2026 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant