build(docs): update Starter Pack and add passthrough to docs Makefile
Metadata
Current evaluation
Merged #478 as e94f190, updating the Starter Pack docs build and adding root Make aliases plus docs-* passthrough targets.
Resolution: closed resolved
Reason: PR #478 was approved, passed all CI checks, and merged into main as commit e94f190, adding the documented docs aliases and passthrough targets.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Add aliases and passthrough Make targets provided by the docs project. With this, you can run make at the root of the project and access docs commands. The behaviour is:
- `docs` safely calls `html`
- `docs-auto` safely calls `serve`
- `docs-clean` safely calls `clean`
- `docs-install` calls `vale-install` and then calls root `setup-docs`
- `docs-*` passes through to all other doc targets
The goal is to keep the docs build nearly unedited. For this to work as of Starter Pack 1.3.1, the `VALEDIR` var in the docs Makefile must be changed to a conditional assignment (`?=`).
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/starbase/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 #478 as e94f190, updating the Starter Pack docs build and adding root Make aliases plus docs-* passthrough targets. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged into main as e94f190, updating Starter Pack and adding root Make aliases and passthrough targets so documentation commands run from the repository root. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged into the default branch. Root Make targets now alias docs html, serve and clean, install prerequisites, and pass through other documentation targets. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after updating the Starter Pack and adding docs Makefile passthrough targets. CI failures were resolved by removing sphinx-toolbox and fixing make docs-help errors. Reviewer feedback was addressed prior to final approval. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #135 docs: use Canonical starter pack | starbase | closed | Canonical Starter Pack adoption was completed by merged PR #478 (commit e94f190), updating the docs build and adding Make passthrough targets. | |
| #1112 build(docs): refresh starter pack implementation | rockcraft | merged | Merged in PR #1112 via commit 61e6bf3a, refreshing the docs starter pack, adding a wordlist, local docs-auto serving, and docs-lint coverage. | |
| #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. | |
| #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. | |
| #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. | |
| #499 build(docs): upgrade Starter Pack to 1.5 | starbase | merged | Merged canonical/starbase#499 in commit 8c01792, upgrading the documentation Starter Pack from 1.3.1 to 1.5 for CRAFT-5035. | |
| #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. | |
| #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). | |
| #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. | |
| #523 docs: update Starter Pack variables | starbase | merged | Merged PR #523 as commit 25d7d15, correcting a Starter Pack variable name missed in #499 (8c01792). The autobuild problem was deliberately deferred to a future upstream variable. |