Add reference docs for the pydantic models
Metadata
Current evaluation
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.
Suggested action: keep open
Reason: This is a valid, maintainer-filed enhancement (author lengau, labelled Type: Enhancement/Documentation) that is partially delivered but not finished: docs/reference/models/ now contains only index.rst, platforms.rst and project.rst, added by commits 469bf24f ('docs(models): add reference and how-to for Platforms models. (#736)') and 2bf6e149 ('docs: document the `project.Project` model (#845)'), while craft_application/models/ still exports undocumented models (GrammarAwareProject, BaseMetadata, CraftBaseModel, Spread*, PackState/PackedArtifact, constraints). The request is clear in intent but spans many pages of prose authoring, so it needs per-model scoping rather than a single turnkey change. The only comment is an autogenerated Jira sync bot message (CRAFT-4207), so there is no maintainer discussion narrowing scope, which is why actionability is only moderate.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
40
Quick Win:
13
Complexity:
40
Confidence:
84
Actionability:
55
|
keep 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. | |
| qwen/qwen3.6-35b-a3b |
Impact:
35
Quick Win:
17
Complexity:
25
Confidence:
75
Actionability:
65
|
keep open | Documentation enhancement to add reference pages for craft-application's Pydantic models, explaining default values and override considerations. | |
| qwen/qwen3.8-27b |
Impact:
35
Quick Win:
23
Staleness:
65
Complexity:
35
Confidence:
75
Support Request:
10
|
keep open | Request to add reference documentation for craft-application's Pydantic models, including reasons for defaults. Partially addressed: project.rst and platforms.rst exist in docs/reference/models/, but full scope (all models, default rationale) appears incomplete. Inactive ~12 months; project remains very active. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
90
Complexity:
15
Confidence:
85
Support Request:
5
|
close stale | Request to add reference documentation for craft-application's Pydantic models, explaining default configurations. Currently unaddressed and inactive for over 10 months. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
10
Confidence:
80
Support Request:
0
|
close stale | Documentation enhancement to add reference pages for Pydantic models in craft-application. Created by a maintainer over 16 months ago with no human activity or progress since. |
Update history
No update history recorded yet.
Related work
-
Related To:
craft-application#736
(confidence 92%)
Commit 469bf24f merged docs/reference/models/platforms.rst, partially satisfying this tracking issue for the Platforms models.
-
Related To:
craft-application#845
(confidence 92%)
PR merged as commit 2bf6e149, adding docs/reference/models/project.rst for project.Project, one of the models this issue asks to document.
-
Related To:
craft-application#910
(confidence 70%)
Commit 2f03a3bc 'docs: add application structure explanation' also touched docs/reference/models/index.rst, part of the same documentation effort.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #736 docs(models): add reference and how-to for Platforms models. | craft-application | merged | Merged in canonical/craft-application#736 via commit 469bf24f, adding Platforms/PlatformsDict reference docs and a guide for app-specific platform models. |