snapcraft.yaml reference documentation missing descriptions for part keys
Metadata
Current evaluation
Missing snapcraft.yaml part key descriptions were added and integrated with Craft Parts source code. The documentation update was completed and merged via pull request #5566 in the canonical/snapcraft repository.
Suggested action: —
No scores available.
Issue body
### What needs to get done
The part keys in the new [snapcraft.yaml reference](https://documentation.ubuntu.com/snapcraft/latest/reference/project-file/snapcraft-yaml/#part-keys) miss the original descriptions (see [forum](https://forum.snapcraft.io/t/snapcraft-yaml-schema/4276)).
### Why it needs to get done
Descriptions should be added. It is hard to guess the syntax and advanced grammar support without them.
(Also, it would be nice to have a new issue type for documentation issues)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Missing snapcraft.yaml part key descriptions were added and integrated with Craft Parts source code. The documentation update was completed and merged via pull request #5566 in the canonical/snapcraft repository. | |
| qwen/qwen3.6-35b-a3b | — | — | Missing descriptions for part keys in the snapcraft.yaml reference documentation were resolved. PR #5566 merged the fix, integrating the descriptions with the Craft Parts source code to ensure consistency across all craft tools. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Missing descriptions for snapcraft.yaml part keys were added by integrating documentation with the Craft Parts source code. The fix was completed and merged in pull request #5566, ensuring consistent reference documentation across craft tools. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Missing descriptions for part keys in the snapcraft.yaml reference documentation were resolved. The fix was merged in pull request #5566, integrating updated descriptions with the Craft Parts source code for consistency. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5566 docs: add part keys to `snapcraft.yaml` reference | snapcraft | merged | Merged documentation update adding updated part key descriptions to the snapcraft.yaml reference. Keys are ordered by importance, prominence, build lifecycle, and alphabetically. Approved by two reviewers and passed CI checks. | |
| #131 add document detailing the snapcraft.yaml syntax | snapcraft | merged | Successfully merged documentation detailing the snapcraft.yaml syntax. The author rebased changes to master and resolved a minor version control mix-up, integrating the new syntax reference guide into the repository. | |
| #1617253 snapcraft syntax documentation is incomplete | snapcraft (launchpad) | open | 10-year-old report that snapcraft.yaml syntax docs omitted app-level plugs. Docs have since been fully restructured into docs/reference/ (58 files); the old URL paths no longer exist. No maintainer interaction, zero comments. |