← Back to issue list

docs: add explanation, reference, and how to for bases

View original Github issue

Metadata

Project
snapcraft
Number
#4900
Type
pull request
State
merged
Author
mr-cal
Labels
Created
Updated
Closed

Current evaluation

Merged documentation updates adding explanation, reference, and how-to pages for base and build-base configuration. Content was refined based on reviewer feedback and incorporates existing craft-parts documentation.

Suggested action:

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `tox run -m lint`? - [x] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`) ----- My task is to document how to use `base` and `build-base` for a kernel snap. This required laying groundwork: * import bases documentation from https://snapcraft.io/docs/base-snaps * This is a 5-year-old doc with minimal upkeep and wasn't a great starting point * add [explanation](https://canonical-snapcraft--4900.com.readthedocs.build/en/4900/explanation/bases.html), [reference](https://canonical-snapcraft--4900.com.readthedocs.build/en/4900/reference/bases.html), and [how-to](https://canonical-snapcraft--4900.com.readthedocs.build/en/4900/howto/bases.html) pages for bases (CRAFT-3083)

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation updates adding explanation, reference, and how-to pages for base and build-base configuration. Content was refined based on reviewer feedback and incorporates existing craft-parts documentation.
qwen3.6-35b-a3b-mtp-q6 Merged documentation adding explanation, reference, and how-to pages for base and build-base configuration. Review feedback refined content to focus on current kernel snap building methods. Unrelated test failures tracked separately.
qwen3.6-35b-a3b-mtp-q6 Merged documentation adding explanation, reference, and how-to guides for base and build-base in kernel snaps. Content was refined per review to focus on current build methods, with craft-application upstreaming deferred.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#597 doc: add explanation and guide for "bases" rockcraft merged Merged after three approvals. Added documentation explaining bases and a rock conversion how-to guide. Fixed a devel reference in reference docs and added documentation links to the rockcraft init YAML template.
76%
#404 docs: add an explanation of parts craft-parts merged Merged documentation update explaining parts, adding 628 lines across nine files. Approved by one reviewer, references CRAFT-1612, and was finalized after initial feedback collection.
74%
#998 docs: add 'specify a base' how-to rockcraft merged Merged documentation update adding a how-to guide for specifying a base. Approved by two reviewers after incorporating heading feedback. Changes spanned six files with 94 additions and 4 deletions, passing all CI checks.
73%
#1939 feat(docs): add craft-parts common documentation charmcraft merged Merged documentation update integrating common craft-parts reference material across eight files. Approved by two reviewers, the change establishes the foundation for upcoming python and poetry plugin guides.
72%
#999 docs: reference document for the Build Plan Service craft-application merged Merged documentation update adding a reference guide for the Build Plan Service (CRAFT-4498). Approved by two reviewers, passed all CI checks, and modified three files with 26 additions and one deletion.
70%
#765 docs: fix explanation pages craft-parts merged Merged documentation update for Rockcraft and Craft Parts. Proofread explanation pages, fixed sections and links, and addressed undefined label warnings. Approved by three reviewers and integrated after confirming unrelated test failures.
70%