docs: bring all starter pack documentation checks into docs lint
Metadata
Current evaluation
Integrated Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint workflow. Resolved and merged via pull request #478.
Suggested action: —
No scores available.
Issue body
Context: https://github.com/canonical/craft-store/pull/104/files/0e3d99995f1424281837cafa1a8152ac0f90866d#r1349033443
Canonical's [Sphinx docs starter pack](https://github.com/canonical/sphinx-docs-starter-pack) uses several linters we should include:
* Woke (with Canonical's inclusive-naming configuration)
* linkcheck
* pyspelling
Ensure we use their configuration as well.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Integrated Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint workflow. Resolved and merged via pull request #478. | |
| qwen/qwen3.6-35b-a3b | — | — | Resolved via pull request #478 by integrating Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint process. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Integrated Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint workflow. Resolved and merged via pull request #478. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #420 docs: bring all starter pack documentation checks into tox | craft-providers | open | Enhancement to integrate Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into tox. Related issue craft-store#105 closed because project is moving away from tox. | |
| #300 docs: refactor documentation for sphinx-starter-pack | rockcraft | merged | Merged documentation refactoring to align with sphinx-starter-pack. Approved by three reviewers and passed CI. Modified 28 files (+351/-63) to standardize structure, validate with pylint, shellcheck, and sphinx, and simplify future integration. | |
| #478 build(docs): update Starter Pack and add passthrough to docs Makefile | starbase | merged | Merged after updating the Starter Pack and adding docs Makefile passthrough targets. Resolved CI warnings by removing sphinx-toolbox, fixed make docs-help failures, and incorporated reviewer feedback. Successfully integrated. | |
| #1112 build(docs): refresh starter pack implementation | rockcraft | merged | Merged an external contribution refreshing the documentation starter pack. The update integrates the latest upstream pack, adds a project-specific wordlist, and documents new make commands for building and linting. Approved by two reviewers and passed CI checks. | |
| #979 chore: rename starter pack submodule | rockcraft | merged | Merged the rename of the documentation submodule to sphinx-docs-starter-pack. CI passed after a separate PR resolved a lint error. Release notes and contributor sync instructions were added. | |
| #275 build(docs): incorporate the latest Sphinx Starter Pack | imagecraft | merged | Merged the latest Sphinx Starter Pack into the documentation build configuration. Approved by three reviewers. Initial CI failures on fast tests and builds were deemed unrelated by the maintainer, and the changes were successfully merged across 23 files. | |
| #197 chore: use Canonical's sphinx-docs-starter-pack | craft-cli | merged | Merged to main following approval and CI checks. Integrated Canonical's Sphinx documentation starter pack, relocating doc dependencies to a requirements file across 31 changed files. Resolves #187. | |
| #398 docs: add linkcheck to doc checks | starbase | merged | Merged after the author narrowed the scope to only adding linkcheck to doc checks, following reviewer feedback that the broader Starter Pack integration was too volatile. | |
| #131 ci: check for changes to docs in linters and tests | starflow | merged | Merged. Updates CI to detect documentation changes in linters and tests, and upgrades to Starter Pack 1.5. Approved by two reviewers with all continuous integration checks passing across multiple platforms. | |
| #551 docs: resolve `docs-lint` issues | starbase | merged | Merged after resolving documentation linting issues. Excluded docs/_dev/ from Sphinx linting and updated link checker timeout. Passed all CI checks, received approval, and was successfully integrated. |