docs: move craft-for-platforms → craft-a-snap
Metadata
Current evaluation
Merged docs PR #5185 (commit a34296875 / 9bf676b) renaming the craft-for-platforms how-to directory to craft-a-snap, adding redirects for old paths.
Resolution: closed resolved
Reason: The PR was approved and merged into main as commit a34296875 ("docs: move craft-for-platforms → craft-a-snap (#5185)", head 9bf676b), moving 35 docs files and updating refs. Later follow-ups af052bbfe and 47574a240 renamed the directory again to craft during docs reorganisation.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged docs PR #5185 (commit a34296875 / 9bf676b) renaming the craft-for-platforms how-to directory to craft-a-snap, adding redirects for old paths. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #5185 (commit 9bf676b), renaming the craft-for-platforms documentation directory to craft-a-snap. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #5185 (commit a34296875), renaming the documentation directory from craft-for-platforms to craft-a-snap to reflect its focus on building snaps for languages and frameworks. | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Superseded By:
canonical/snapcraft#5440
(confidence 55%)
Commit af052bbfe ("docs: rename `craft-a-snap` dir to `craft`") followed by 47574a240 ("docs: reorganise pages", #5440) later moved/renamed the same directory again.
-
Related To:
canonical/snapcraft#5235
(confidence 50%)
Commit 7254a4bd5 "feat(docs): add redirects (#5235)" added the redirects that preserve URLs from the earlier howto/craft-a-snap layout.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5160 docs: port the platform integration guides from Discourse | snapcraft | merged | Merged PR #5160 in commit dc96a6d8a, porting platform integration guides from Discourse into Snapcraft documentation. | |
| #4679 refactor(docs): use more docs from craft-parts | snapcraft | merged | Merged #4679 as b8c9a17dc, replacing duplicated Snapcraft docs with direct craft-parts TOC references or includes for shared content. | |
| #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). | |
| #5586 docs: improve and move setup guides | snapcraft | merged | Merged PR #5586 improved and relocated the Snapcraft setup guides based on internal feedback, landing as commit dacb9c702. |