build(docs): refresh starter pack implementation
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
All craft apps must re-integrate the latest [documentation starter pack](https://github.com/canonical/sphinx-docs-starter-pack).
This work replicates [canonical/snapcraft#6037](https://github.com/canonical/snapcraft/pull/6037).
The updated starter pack introduces a new `wordlist`. This list has been updated based on the documentation set.
The following changes are also documented:
- `make docs-auto` now builds the documentation and serves it on http://127.0.0.1:8000/.
- Documentation is tested with `make docs-lint`.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged an external contribution refreshing the documentation starter pack. It integrates the latest sphinx-docs-starter-pack, updates the wordlist, and adds make docs-auto and make docs-lint commands for building and linting. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged refresh of the documentation starter pack. Changes integrate the latest sphinx-docs-starter-pack, add a new wordlist, and introduce make docs-auto for building and serving docs alongside make docs-lint for validation. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #6037 build(docs): refresh starter pack implementation | snapcraft | merged | Merged. Refreshed the documentation starter pack across 73 files, re-integrating the latest version. Kept templates for GA enablement per feedback. Passed CI, approved by three reviewers, and fixes #5071. | |
| #1482 build(docs): refresh starter pack implementation | craft-parts | merged | Merged update refreshing the starter pack implementation to version 1.4.0. Resolves #1454 and fixes CRAFT-5015. The change modifies 35 files, passes all CI checks, and received dual reviewer approval before being merged. | |
| #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. | |
| #1070 build(docs)!: add dependency starter pack 1.5 | craft-application | merged | Merged after three approvals and passing all CI checks. Adds dependency starter pack 1.5 to fix documentation-only pull request build failures, updating 44 files with 1823 additions and 337 deletions. | |
| #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. | |
| #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. | |
| #2594 build(docs)!: update canonical starter pack to 1.5 | charmcraft | merged | Merged after two approvals. Updates the canonical starter pack to version 1.5 and resolves issue #2558. Required CI checks passed. Author noted pending fixes for substitution extension and Git lastmods will be handled separately. | |
| #130 ci: check for changes to docs in linters and tests | starflow | closed | Superseded by PR #131. Added CI checks for documentation changes and updated Starter Pack to 1.5. Closed after reviewers requested recreating it on a main repository branch to resolve fork workflow failures. | |
| #136 docs: bring all starter pack documentation checks into docs lint | starbase | closed | Integrated Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint workflow. Resolved and merged via pull request #478. | |
| #523 docs: update Starter Pack variables | starbase | merged | Merged documentation update correcting Starter Pack variables previously missed in PR #499. Scope limited to variable name fixes only, deferring the autobuild issue to a separate upstream fix. Approved by two reviewers and passed CI checks. |