docs: maintain project file terminology
Metadata
Current evaluation
Merged as commit 5330ae796 (head 19dff5b): docs sweep replacing 'snapcraft.yaml' with 'project file' where appropriate across 43 files (+792/-672), with snippet captions, indentation fixes, and a corrected Java example name.
Resolution: closed resolved
Reason: The PR itself was the resolution and it was merged into main as commit 5330ae796 ("docs: maintain project file terminology (#5256)"), after approval by two reviewers. No failing CI checks; codecov reported full coverage of modified lines and mr-cal noted test failures were unrelated.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- Replace "snapcraft.yaml" with "project file" where appropriate.
- Adjust code block indentation and language.
- Add filename caption to snapcraft.yaml snippets.
- Replace some instances of "keyword" with "key".
- Fix name of example Java app.
- [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 `tox run -m lint`?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit 5330ae796 (head 19dff5b): docs sweep replacing 'snapcraft.yaml' with 'project file' where appropriate across 43 files (+792/-672), with snippet captions, indentation fixes, and a corrected Java example name. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5256 (commit 19dff5b), standardizing documentation on “project file” terminology, updating snippets and captions, and correcting a Java example name. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged docs cleanup standardized “project file” terminology, corrected YAML snippets and example names, and added filename captions across Snapcraft documentation. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#5256 (commit 19dff5b), standardizing docs on “project file” terminology, updating snippets and captions, and fixing a Java example name. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation terminology standardized by replacing "snapcraft.yaml" with "project file" throughout the codebase. Changes include adjusted indentation, fixed example app names, and updated captions. Approved by reviewers, passed CI checks, and successfully merged. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates standardizing terminology to project file, fixing code formatting, and correcting an example app name. Approved by @mr-cal and merged after passing coverage checks, with unrelated test failures noted. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#5924
(confidence 72%)
Later follow-up 'docs: clean up snapcraft.yaml' (commit 83f961ebc) continuing the same terminology cleanup in the docs.
-
Related To:
canonical/snapcraft#5466
(confidence 55%)
Earlier docs migration work on 'snapcraft.yaml' pages that this terminology pass builds on.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #814 docs: maintain project file terminology | rockcraft | merged | Merged PR #814 standardized documentation on "project file" and "key," reformatted code blocks, and captioned rockcraft.yaml snippets across 27 files in commit 93162c82. | |
| #5466 docs: migrate 'snapcraft.yaml' | snapcraft | merged | Merged the snapcraft.yaml documentation migration into the Read the Docs project-file reference via commit 2670e8278 (#5466). | |
| #4680 fix: show better error when project file is missing | snapcraft | closed | Merged in canonical/snapcraft#4680, improving the error shown when a project file is missing; the maintainer confirmed the code remained necessary for documentation links. | |
| #411 docs: refer to the working directory | craft-parts | merged | Merged docs cleanup in #411 (commit cf66c5c3), replacing overly Snapcraft-specific wording with references to the working directory. | |
| #6283 docs: fix syntax for H1 heading | snapcraft | merged | Merged docs-only typo fix to an H1 heading syntax in Snapcraft documentation. Merged to main as commit a85c8fdf8 (PR canonical/snapcraft#6283), a +1/-1 line change with no functional impact. | |
| #2169 docs: replace "recipe" as a term | charmcraft | merged | Merged PR #2169 (commit ca5e93cf) replaced "recipe" with better terminology across 7 doc files (+73/-73), finishing leftover CRAFT-4000 work; reviewer lint fixes included per maintainer comment. |