← Back to issue list

build(docs): refresh starter pack implementation

View original Github issue

Metadata

Project
snapcraft
Number
#6037
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

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.

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/starbase#478. Fixes #5071. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/snapcraft/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. - [x] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen3.6-35b-a3b-mtp-q6 Merged the documentation starter pack refresh. The update aligns the build with the latest canonical/sphinx-docs-starter-pack. Reviewers confirmed that custom _templates files must be retained for GA enablement. Fixes #5071.
qwen3.6-35b-a3b-mtp-q6 Merged refresh of the documentation starter pack implementation. The templates directory was retained to support GA enablement, as its contents are not included in the starter pack. Resolves #5071.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
85%
#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.
84%
#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.
78%
#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.
77%
#499 build(docs): upgrade Starter Pack to 1.5 starbase merged Merged the Starter Pack upgrade to version 1.5. Approved by two reviewers and passed all CI checks. Modified 12 files (+114/-459 lines). Resolves CRAFT-5035.
76%
#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.
74%
#490 build(deps): remove unused docs dependencies starbase merged Merged after approval and CI checks. Unused documentation dependencies were removed and kept commented out pending Starter Pack removal. A reviewer requested clarification, addressed via a follow-up commit adding explanatory comments.
72%
#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.
72%
#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.
72%
#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.
72%