← Back to issue list

Add reference docs for the pydantic models

View original Github issue

Metadata

Project
craft-application
Number
#662
Type
issue
State
open
Author
lengau
Labels
Type: Enhancement Type: Documentation
Created
Updated
Closed

Current evaluation

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.

Suggested action: keep open

Reason: The issue is a valid documentation enhancement filed by a maintainer (lengau) and partially addressed via PR #845 (project.Project model docs) and the platforms.rst page, but the broader scope of documenting all Pydantic models with rationale for defaults remains open. The project is very active with frequent docs commits, so the issue is still relevant. No clear reason to close beyond inactivity.

Impact: 35 Quick Win: 22.75 Staleness: 65 Complexity: 35 Confidence: 75 Support Request: 10

Issue body

### What needs to get done Add reference documentation pages for the various Pydantic models that craft-application uses, including reasons for certain defaults to provide better understanding before an application overrides them. ### Why it needs to get done This documentation currently only exists in code and in our heads.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 35
Quick Win: 22.75
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 15
Confidence: 60
Support Request: 0
close stale Add reference documentation for craft-application's Pydantic models, explaining default configurations currently only in code. Open, synced to Jira ticket CRAFT-4207, awaiting implementation after 286 days of inactivity.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/craft-application#845 (confidence 55%)

    PR #845 added reference docs for the project.Project model, which is the top-level Pydantic model mentioned in the issue. However, the issue asks for 'various Pydantic models' and 'reasons for certain defaults,' so this is only a partial fix.

Related issues

No related issues found above the similarity threshold.