docs: migrate 'snapcraft.yaml'
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation migration moving snapcraft.yaml build configuration content from snapcraft.io to ReadTheDocs. Content was added to the project file index as a brief overview, resolving SNAPCRAFT-394. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5463 docs: migrate 'hooks' | snapcraft | merged | Merged documentation migration for 'hooks' to ReadTheDocs. Approved by two reviewers with all CI checks passing. Updated three files (+105/-1 lines) to align with SNAPCRAFT-395. | |
| #5924 docs: clean up 'snapcraft.yaml' | snapcraft | merged | Merged documentation cleanup for snapcraft.yaml, including typo fixes, docstring link updates, and JSON schema regeneration. Reviewers approved the non-functional changes, and the schema workflow was resolved by running make schema. | |
| #5409 docs: migrate 'migrate between bases' | snapcraft | merged | Merged after reviewer approval and CI validation. The pull request migrated documentation for changing Snapcraft bases, restructuring the content into a dedicated how-to guide as agreed in comments. | |
| #5462 docs: migrate 'Snapcraft advanced grammar' | snapcraft | merged | Merged documentation migration for the Snapcraft advanced grammar reference. Approved by two reviewers and passed CI checks before being squashed into the main branch. | |
| #5410 docs: migrate 'adding snap configuration' | snapcraft | merged | Merged documentation update migrating the 'adding snap configuration' guide. Approved by two reviewers. CI passed most checks despite failing integration tests on Ubuntu 20.04, 22.04, and 24.04. Changes affect five files with 352 additions and 8 deletions. | |
| #5342 docs: migrate 'check a snap's status' | snapcraft | merged | Merged documentation update migrating the 'check a snap's status' guide. Approved by two reviewers, the change modified four files with 133 additions and 8 deletions. | |
| #502 docs: add 'about this documentation' | starbase | merged | Merged after approval by two reviewers and passing all CI checks. Added mandatory 'about this documentation' page, modifying three files (+49/-1) to align with canonical/snapcraft standards. | |
| #416 docs: update contribution links | starbase | merged | Merged documentation update aligning contribution links with Snapcraft. Approved by two reviewers, passed all CI checks, and modified one file with three additions and three deletions. | |
| #5185 docs: move craft-for-platforms → craft-a-snap | snapcraft | merged | Merged documentation update renaming the craft-for-platforms directory to craft-a-snap. The change better reflects the actual user task of building snaps across languages and frameworks. Approved by reviewers and passed CI checks. | |
| #5373 docs: migrate 'debug a snap' | snapcraft | merged | Merged documentation update migrating the 'debug a snap' guide. Approved by two reviewers, the change spans five files with 206 additions and 37 deletions, successfully integrating the updated content. |