build(docs): refresh starter pack implementation
Metadata
Current evaluation
Merged in PR #1112 via commit 61e6bf3a, refreshing the docs starter pack, adding a wordlist, local docs-auto serving, and docs-lint coverage.
Resolution: closed resolved
Reason: PR #1112 was approved and merged as commit 61e6bf3a. It updated the documentation starter-pack integration and introduced wordlist, docs-auto, and docs-lint support.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in PR #1112 via commit 61e6bf3a, refreshing the docs starter pack, adding a wordlist, local docs-auto serving, and docs-lint coverage. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged the starter-pack refresh, adding a wordlist, local docs-auto serving, and docs-lint checks; it replicated canonical/snapcraft#6037. | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#6037
(confidence 100%)
The Rockcraft change explicitly replicated the equivalent Snapcraft documentation refresh.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #6037 build(docs): refresh starter pack implementation | snapcraft | merged | Merged PR #6037 (commit 4ee7c7e9f) refreshed Snapcraft's documentation starter pack to 1.4.0 across 73 files, resolving #5071; approvals and all CI checks passed. | |
| #1482 build(docs): refresh starter pack implementation | craft-parts | merged | Maintainer medubelko merged PR #1482 bumping the docs to Starter Pack 1.4.0 (+1371/-1094 across 35 files), resolving the `details` directive issue #1454 and CRAFT-5015. | |
| #1070 build(docs)!: add dependency starter pack 1.5 | craft-application | merged | Merged PR #1070 added dependency starter pack 1.5 to fix docs-only PR builds, landing as commit 691eec7e with all CI checks passing. | |
| #275 build(docs): incorporate the latest Sphinx Starter Pack | imagecraft | merged | Merged PR #275 (commit 097e5f5), refreshing the docs build with the latest canonical Sphinx Starter Pack across 23 files; author noted the failing fast-test/build checks were unrelated. | |
| #136 docs: bring all starter pack documentation checks into docs lint | starbase | closed | Added Canonical Starter Pack checks for Woke, linkcheck and spelling, wiring them into docs-lint via merged PR #478 (commit e94f190). | |
| #478 build(docs): update Starter Pack and add passthrough to docs Makefile | starbase | merged | Merged #478 as e94f190, updating the Starter Pack docs build and adding root Make aliases plus docs-* passthrough targets. | |
| #718 Docs: Rebase against newer starter pack | rockcraft | closed | Closed in favor of internal ticket CRAFT-3492; PR #1112 separately refreshed the docs starter pack in commit 61e6bf3a. | |
| #131 ci: check for changes to docs in linters and tests | starflow | merged | PR #131 merged documentation-change checks into linters and tests, upgraded Starter Pack to 1.5, and passed all CI checks. | |
| #1926 Docs: Rebase against newer starter pack | charmcraft | open | Docs maintenance task to rebase against newer RTD starter pack; appears completed by commit 6264ff78 updating the canonical starter pack to 1.5. | |
| #2594 build(docs)!: update canonical starter pack to 1.5 | charmcraft | merged | Merged #2594 as 6264ff78, updating the Canonical Starter Pack to 1.5 and correcting the “Contribute to this page” icon/link issue tracked in #2558. |