docs: add explanation, howto, and reference for components
Metadata
Current evaluation
Merged after approval and passing CI checks. Added explanation, how-to, and reference documentation for components, resolving issue #4857. Unrelated test failures were noted but did not block the merge.
Suggested action: —
No scores available.
Issue body
- [ ] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox run -m lint`?
- [ ] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
-----
Add [explanation](https://canonical-snapcraft--4904.com.readthedocs.build/en/4904/explanation/components.html), [how-to](https://canonical-snapcraft--4904.com.readthedocs.build/en/4904/howto/components.html), and [reference](https://canonical-snapcraft--4904.com.readthedocs.build/en/4904/reference/components.html) for components.
Fixes #4857
(CRAFT-3028)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after approval and passing CI checks. Added explanation, how-to, and reference documentation for components, resolving issue #4857. Unrelated test failures were noted but did not block the merge. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding explanation, how-to, and reference guides for components. Resolves issue #4857. Unrelated test failures were noted but did not block integration. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding explanation, how-to, and reference guides for components. Resolves issue #4857. Unrelated test failures were noted but did not block the merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5174 docs: update component documentation | snapcraft | merged | Merged after two reviewer approvals and passing CI. Updates component documentation by replacing deprecated type test with type standard and adding runtime mounting details, resolving issue 5162. | |
| #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. | |
| #4349 docs(architectures): add how-to, reference, and explanation | snapcraft | merged | Merged documentation updates adding how-to, reference, and explanation guides for architectures. Resolved issue #4336 after three approvals and passing CI. Minor style suggestions and a negligible coverage drop were noted but did not block the merge. | |
| #5179 docs: fix component type in the howto | snapcraft | merged | Merged a documentation fix correcting the component type in docs/howto/code/components-organize/snapcraft.yaml. The change followed up on PR 5174, passed all CI checks, and received approval from three reviewers before being merged. | |
| #354 docs: incorporate tutorial feedback | imagecraft | merged | Merged documentation updates incorporating tutorial feedback. Approved by a reviewer, passed all CI checks, and modified four files. Changes preempt updates in a related pull request. | |
| #5757 docs: add docs for setting component versions | snapcraft | merged | Merged documentation update adding release notes for component version settings and linking the component how-to to the craftctl guide. Approved by two reviewers and passed all CI checks. | |
| #294 docs: add CONTRIBUTING.md | craft-store | merged | Merged addition of CONTRIBUTING.md documentation. Approved by two reviewers and passed most CI checks. Minor discussions about local integration test instructions were noted but did not block the merge. | |
| #4267 docs: add command reference | snapcraft | merged | Merged after two approvals and passing CI. Added command reference documentation across 10 files. Required merging prerequisite PR #4272 to fix ReadTheDocs builds before updating the branch and finalizing the merge. | |
| #1011 docs: maintain explanation quadrant | rockcraft | merged | Merged documentation updates aligning the explanation landing page with the model, standardizing labels, and ingesting common docs. Approved by two reviewers and merged despite a failing snap-tests CI check. | |
| #1104 docs: update links | craft-parts | merged | Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures. |