docs: Clean and document new fields
Metadata
Current evaluation
Merged documentation updates for imagecraft.yaml covering overlay and volumes fields, cleaned ubuntu-image references, and an improved example. Approved by two reviewers, passed CI, and modified 22 files.
Suggested action: —
No scores available.
Issue body
- [ ] Have you followed the guidelines for contributing?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `make lint && make test`?
---
- add documentation on overlay
- clean references to `ubuntu-image`
- document the `volumes` section of the `imagecraft.yaml` (and other common fields)
- add a better `imagecraft.yaml` example (will evolve in future PRs but is now closer to what imagecraft expects)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates for imagecraft.yaml covering overlay and volumes fields, cleaned ubuntu-image references, and an improved example. Approved by two reviewers, passed CI, and modified 22 files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for imagecraft.yaml covering overlay, volumes, ubuntu-image references, and an improved example. The reviewer restored the Part properties page, noting an upcoming Pydantic extension will handle project file references. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for imagecraft.yaml covering overlay, volumes, and ubuntu-image references. The improved example was accepted. Part properties page restoration was confirmed, pending a future Pydantic model extension. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #173 docs: update 'imagecraft.yaml' | imagecraft | merged | Merged documentation update for imagecraft.yaml. Changes include reordering part keys and adding a manual description to the organize directive. The request received reviewer approval, passed CI checks, and was successfully integrated. | |
| #156 docs: update yaml reference | imagecraft | merged | Merged following approval and successful CI checks. Automates the imagecraft.yaml reference documentation using Kitbash, extracting content from docstrings in PR #153. Modified 5 files with +134/-210 lines. | |
| #245 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged documentation cleanup for imagecraft.yaml. Updates include upgrading pydantic-kitbash to v0.1.1, removing legacy workarounds, fixing typos, and refining docstrings. Approved by two reviewers and successfully merged. | |
| #436 docs: Imagecraft 1.0 release notes | imagecraft | merged | Merged following approval by two reviewers and successful CI execution. The change adds documentation for the Imagecraft 1.0 release notes across six files, introducing 82 lines and removing 34. | |
| #39 Document the imagecraft.yaml configuration file | imagecraft | merged | Merged documentation for the imagecraft.yaml configuration file. Approved by one reviewer with zero unresolved comments. Changes span 24 files, adding 1253 lines and removing 113. CI passed with 97.66% test coverage. Resolves FR-7038. | |
| #293 docs: reorder 'imagecraft.yaml' reference | imagecraft | merged | Merged documentation update to reorder keys in the imagecraft.yaml reference. Aligns the reference with the init template by placing volume and filesystem keys before part keys. Approved and merged. | |
| #177 docs: instruct to get imagecraft from beta channel | imagecraft | merged | Merged documentation update directing users to install imagecraft from the beta channel. Approved by three reviewers and passed CI checks. Modified one file to update installation instructions. | |
| #120 feat: Add needed fields for imagecraft | craft-archives | merged | Merged after two approvals and passing CI. Implements FO169 to adapt craft-archives for imagecraft, adds required fields, and documents priority. Modified eight files with 341 additions and 34 deletions. | |
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83). | |
| #1307 docs: improve the file migration explanation | craft-parts | merged | Merged documentation update improving the file migration explanation. Addressed reviewer feedback by rephrasing text, converting images to figures with captions, and adding alt text per W3 guidelines. Approved by two reviewers and passed CI checks. |