docs: migrate 'snapcraft.yaml'
Metadata
Current evaluation
Merged the snapcraft.yaml documentation migration into the Read the Docs project-file reference via commit 2670e8278 (#5466).
Resolution: closed resolved
Reason: PR #5466 was approved and merged with all CI checks passing. Commit 2670e8278 added the migrated build configuration and build process content to the project-file documentation.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint`?
- [x] Have you successfully run `make test`?
---
Migrates https://snapcraft.io/docs/build-configuration and the "snapcraft.yaml" section from https://snapcraft.io/docs/how-snapcraft-builds to [RTD](https://canonical-snapcraft--5466.com.readthedocs.build/en/5466/reference/project-file/).
I added the content to the project file index since it serves as a brief overview and didn't fit perfectly into either of the subpages.
(SNAPCRAFT-394)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged the snapcraft.yaml documentation migration into the Read the Docs project-file reference via commit 2670e8278 (#5466). | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in commit 2670e8278 (#5466), moving snapcraft.yaml build-configuration and build-process documentation from snapcraft.io to the Read the Docs project-file reference. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation migration moving snapcraft.yaml build configuration content from snapcraft.io to ReadTheDocs. Content added to the project file index. Approved by two reviewers with all CI checks passing. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation migration moving snapcraft.yaml build configuration content from snapcraft.io to ReadTheDocs. Content was integrated into the project file index, resolving SNAPCRAFT-394. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5463 docs: migrate 'hooks' | snapcraft | merged | Merged the snap hooks documentation migration from snapcraft.io to Read the Docs in commit 6f4c66e59. | |
| #5409 docs: migrate 'migrate between bases' | snapcraft | merged | Merged in snapcraft#5409 via commit 30aeaf036, migrating and restructuring the documentation for changing snap bases. | |
| #5462 docs: migrate 'Snapcraft advanced grammar' | snapcraft | merged | Merged the advanced grammar documentation migration in commit b7a56461b; follow-up #5468 restored the Read the Docs build in 0157e5b15. | |
| #5410 docs: migrate 'adding snap configuration' | snapcraft | merged | Migrated the "adding snap configuration" guide into the current docs structure and merged it in commit 7b1784086 via #5410. | |
| #5359 docs: migrate build environment reference page | snapcraft | merged | Merged PR #5359 via commit 1678a1ea9, migrating the legacy build-options page's build environment reference into Snapcraft's in-repo documentation. | |
| #5422 docs: add tutorial | snapcraft | merged | Merged PR #5422 as commit 5c50c42d4, adding a new Snapcraft tutorial and revising 10 documentation files (+795/-90 lines). | |
| #131 add document detailing the snapcraft.yaml syntax | snapcraft | merged | Merged snapcraft.yaml syntax documentation in commit 0039afb12 (merge 4a1f3ff2a); PR #146 later refined the 1.x reference. | |
| #5421 docs: add snapcraft.yaml reference | snapcraft | merged | Merged PR #5421 as commit 8a046bb00, adding generated snapcraft.yaml reference docs, project field docstrings, and pydantic-kitbash integration; the dependency was restored to PyPI before merge. | |
| #5622 docs: add 'About this documentation' | snapcraft | merged | Merged into main as 258251541, adding an "About this documentation" page to the Snapcraft docs. | |
| #5924 docs: clean up 'snapcraft.yaml' | snapcraft | merged | Merged snapcraft.yaml documentation cleanup in #5924 via commit 83f961ebc, upgrading pydantic-kitbash, correcting docstrings and links, and regenerating the JSON schema. |