docs: resolve Vale spellcheck errors from vale 3.22
Metadata
Current evaluation
Merged into main to resolve Vale 3.22.0 spellcheck failures in docs by replacing "PRs" with "pull requests" and adding "venv" and "mv" to the custom wordlist.
Resolution: closed resolved
Reason: The pull request was merged, fixing the docs-lint step failures introduced by the Vale 3.22.0 version bump. The changes update documentation phrasing and extend the custom wordlist to pass CI checks.
Evaluated by: mr-cal-bot
No scores available.
Issue body
🤖 This message was generated by kimi-k3
## What
Fixes the `docs-lint` step of `lint / files` by resolving three Vale `Canonical.000-US-spellcheck` errors.
## Why
`lint / files` fails on canonical/craft-store#439 (lock-file maintenance). The bump itself is not at fault: main passes only because its CI cache pins vale **3.13.0**, while the renovate PR's fresh cache fetched vale **3.22.0**, which newly flags:
- `docs/explanation/documentation.rst:31` — `PRs`
- `docs/tutorials/snap-store-upload-snap.rst:23` — `venv`
- `docs/tutorials/snap-store-upload-snap.rst:34` — `mv`
I reproduced the failure on unmodified `main` (f524474) with vale 3.22.0 + the current `documentation-style-guide` styles: the exact same 3 errors.
## How
- Reword `PRs` → `pull requests`, matching the [starbase template](https://github.com/canonical/starbase/blob/main/docs/explanation/documentation.rst) for this page (same fix as canonical/debcraft#205).
- Add `venv` and `mv` to `docs/.custom_wordlist.txt`. Snapcraft, charmcraft, craft-parts, rockcraft, and imagecraft all carry `venv` in theirs; no other craft repo has a docs code block using `mv`.
Verified locally against this branch: `make -C docs spelling` (vale 3.22.0) reports 0 errors, and `make lint` / `make test-fast` pass. Once merged, ticking the rebase box on #439 should pick the fix up.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | closed resolved | Merged into main to resolve Vale 3.22.0 spellcheck failures in docs by replacing "PRs" with "pull requests" and adding "venv" and "mv" to the custom wordlist. |
Update history
| Date | Change |
|---|---|
| merged | |
| created |
Related work
-
Related To:
canonical/craft-store#439
(confidence 90%)
The lock-file maintenance PR that triggered the Vale version bump and subsequent lint failure.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #205 docs: reword "PRs" to "pull requests" for Vale spellcheck | debcraft | merged | Merged PR #205 to fix Vale spellcheck failure by rewording "PRs" to "pull requests" in docs/explanation/documentation.rst. | |
| #221 docs: spell out pull requests | craft-grammar | merged | Merged PR #221 to fix Vale spellcheck error by spelling out PRs as pull requests in docs/explanation/documentation.rst. | |
| #1346 fix: update vale to remove spelling error issue | rockcraft | closed | Vale 3.7.1 was pinned to avoid newly reported spelling exceptions, but PR #1346 was closed without merging. | |
| #2966 docs: fix spelling errors and Vale linting failures | charmcraft | merged | Merged PR #2966 to fix documentation spelling errors and Vale linting failures in charmcraft, correcting typos in howto guides and updating `.custom_wordlist.txt`. |