docs: move craft-for-platforms → craft-a-snap
Metadata
Current evaluation
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.
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 `tox run -m lint`?
- [x] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
-----
After thorough review, I found that the existing title didn't focus enough on what user _task_ these pages speak to. Really what this directory covers is _crafting a snap_. There's no general case for a snap, so any how-to for them must select a language or framework. While there's plenty more to add to this folder, for now I think this name is suitable.
Regarding a replacement for "platforms", the term "stack" doesn't quite strike me as correct because it implies additional hierarchies that I don't think are always present with languages. I found many instances of other folks in the industry using "languages and frameworks" as an encompassing phrase to include, for example, both Python and Flask. I couldn't find any single word that covers the superset of these two categories. If we do need to discuss them as a whole, I think we should use that phrase.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update renaming the craft-for-platforms directory to craft-a-snap. The change clarifies the user task focus and aligns with preferred terminology. Tests passed and coverage requirements were met. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update renaming craft-for-platforms to craft-a-snap. The new name better reflects the user task of crafting snaps across languages and frameworks. All lint, test, and coverage checks passed before merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #6048 docs: correct 'craftctl' to 'snapctl' in config doc | snapcraft | merged | Merged a documentation fix correcting craftctl to snapctl in the config guide. Approved by two reviewers with passing CI checks. The update modifies one file. | |
| #5466 docs: migrate 'snapcraft.yaml' | snapcraft | merged | 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. | |
| #6092 docs(reference): add platform naming rules | snapcraft | merged | Merged documentation update adding platform naming rules. The change also bumps the craft-application minor release to resolve a lint dependency. Approved by two reviewers and passed CI checks before integration. | |
| #1091 docs: revamp craftctl how-to | craft-parts | merged | Merged documentation update revamping the craftctl how-to guide using upstream Snapcraft content. Approved by two reviewers, CI checks passed after fixes, and changelog updated for a minor release prior to merge. | |
| #6389 docs: fix version in Snapcraft 9 | snapcraft | merged | Merged documentation fix for Snapcraft 9 that updates the docs title to show major and minor versions for builds, with latest showing dev. Aligns with RTD slug simplification. Approved by two reviewers and merged. | |
| #2590 docs: add platform naming rules | charmcraft | merged | Merged documentation update adding platform naming rules from craft-application. Approved by two reviewers. Integrated despite non-blocking CI test failures and type checker notifications. | |
| #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. | |
| #3608 many: rename snapcraft package to snapcraft_legacy (CRAFT-726) | snapcraft | merged | Merged after renaming the snapcraft package to snapcraft_legacy to make room for a new craft libraries-based application. Approved, passed CI, and modified 557 files. The application entry point remains unchanged and will be handled separately. | |
| #1130 docs: add platform naming rules | rockcraft | merged | Merged documentation update adding platform naming rules from Craft Application. Approved by three reviewers with all CI checks passing. A noted merge conflict was resolved prior to final merge. | |
| #411 docs: refer to the working directory | craft-parts | merged | Merged documentation update generalizing working directory references to remove Snapcraft-specific details. Approved by two reviewers and passed CI checks. |