← Back to issue list

Developer docs: Architecture explanation

View original Github issue

Metadata

Project
craft-application
Number
#889
Type
issue
State
open
Author
lengau
Labels
Status: Triaged Type: Enhancement Type: Documentation
Created
Updated
Closed
—

Current evaluation

Maintainer doc request to explain purposes of commands, services, and what a craft app should/shouldn't do; largely delivered by docs/explanation/structure-of-a-craft-app.rst in PR #910.

Suggested action: close resolved

Reason: Commit 2f03a3bc ("docs: add application structure explanation", canonical/craft-application#910) added docs/explanation/structure-of-a-craft-app.rst, which is now listed in docs/explanation/index.rst and covers all three bullets: a Commands section ('what's responsible for user interaction', numbered list of what it should do), a Services section ('where an app's business logic lives', responsibilities, and a caution on cross-service data), and an Application section explaining the glue role plus what Application should not need ('each thing the Application class currently does that requires an override in a craft can be considered a shortcoming'). Confidence is capped at 62 because the issue was never explicitly closed and the third bullet ('should/shouldn't do') is only partially covered, so the maintainer may have intended further content.

Evaluated by: mr-cal-bot

Impact: 35 Quick Win: 21 Complexity: 25 Confidence: 62 Actionability: 80

Issue body

### What needs to get done Explain: - The purpose of a command - The purpose of a service - What the application should/shouldn't do ### Why it needs to get done We keep running into issues because of some of the unintuitive parts of the design.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 35
Quick Win: 21
Complexity: 25
Confidence: 62
Actionability: 80
close resolved Maintainer doc request to explain purposes of commands, services, and what a craft app should/shouldn't do; largely delivered by docs/explanation/structure-of-a-craft-app.rst in PR #910.
qwen/qwen3.6-35b-a3b
Impact: 35
Quick Win: 18
Complexity: 25
Confidence: 80
Actionability: 70
keep open Documentation enhancement to explain command/service purposes and application design intent to reduce developer confusion.
qwen/qwen3.8-27b
Impact: 40
Quick Win: 28
Staleness: 55
Complexity: 30
Confidence: 60
Support Request: 0
keep open Developer docs enhancement to explain the purpose of commands, services, and what the application should/shouldn't do. Triaged by maintainer; a structure-of-a-craft-app explanation page now exists in docs/explanation covering Application, Commands, and Services.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 30
Confidence: 80
Support Request: 10
keep open Documentation enhancement to explain command and service purposes, plus application scope. Triaged but inactive for over a year, awaiting implementation.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 20
Confidence: 85
Support Request: 5
keep open Documentation enhancement to clarify command and service purposes and application boundaries. Triaged by a maintainer but inactive for over ten months.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/craft-application#910 (confidence 78%)

    Commit 2f03a3bc 'docs: add application structure explanation' created docs/explanation/structure-of-a-craft-app.rst with Commands, Services, and Application sections, matching the three requested bullets; it is wired into the Explanation toctree.

Related issues

No related issues found above the similarity threshold.