docs(models): add reference and how-to for Platforms models.
Metadata
Current evaluation
Merged in canonical/craft-application#736 via commit 469bf24f, adding Platforms/PlatformsDict reference docs and a guide for app-specific platform models.
Resolution: closed resolved
Reason: PR #736 was merged after approval, with all CI checks passing. Commit 469bf24f added the requested platform model documentation and how-to guide.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint && make test`?
- [x] Have you added an entry to the changelog (`docs/reference/changelog.rst`)?
---
This adds both reference documentation for how the Platforms model and the PlatformsDict work and a how-to guide for implementing an app-specific platform model.
For @mr-cal and @tigarmo's reviews, this is part of CRAFT-4421.
For @jahn-junior and @medubelko this is part of CRAFT-4485.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-application#736 via commit 469bf24f, adding Platforms/PlatformsDict reference docs and a guide for app-specific platform models. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-application#736 (commit 469bf24f), adding Platforms and PlatformsDict reference docs plus a guide for app-specific platform models. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding reference and how-to guides for Platforms models. Approved by four reviewers, passed all CI checks, and included in the changelog as part of CRAFT-4421 and CRAFT-4485. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #662 Add reference docs for the pydantic models | craft-application | open | Maintainer tracking issue to add reference docs pages for craft-application's Pydantic models, including rationale for defaults before apps override them. Platforms (#736) and Project (#845) documented; several models remain undocumented. | |
| #2080 docs: add platforms reference and how-to | charmcraft | merged | Merged in canonical/charmcraft#2080 (142fa827), adding platforms reference/how-to docs for bases, architectures and multi-base support; fixes #2009. | |
| #6092 docs(reference): add platform naming rules | snapcraft | merged | Merged platform naming rules into the reference docs and bumped craft-application; the related lint fix was handled in canonical/craft-application#1023 (commit 83c5b7d4e). | |
| #735 feat(models): make the Platforms schema and processing work the same | craft-application | merged | Merged #735 in commit 6efd2941, adding generic platform dictionaries so Pydantic/JSON schemas match platform processing; it fixes #688 (CRAFT-4421). |