docs: Add developer documentation
Metadata
Current evaluation
Maintainer tracking issue asking for developer documentation so apps can move to craft-application without reading source. Partly delivered: docs/ now has how-to, reference and explanation sections, but no tutorial/get-started guide remains.
Suggested action: keep open
Reason: This is a labelled, maintainer-authored umbrella documentation issue (CRAFT-2604) that is still valid and unmet in part: since it was opened the repo gained how-to guides (build-remotely, pack-a-pro-artifact, partitions, platforms, add-a-linter), a full reference tree (services, models, commands, pytest-plugin) and explanation pages such as 'structure-of-a-craft-app', yet docs/tutorials still holds only a single index file, so the stated pain — 'moving an app to craft-application requires a lot of looking at source code' — is not fully resolved. It must stay open because it is a valid documentation gap with no evidence of resolution; however its scope is open-ended (no acceptance criteria, no specific pages named), so actionability and confidence are moderate rather than high.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
35
Quick Win:
6
Complexity:
50
Confidence:
72
Actionability:
32
|
keep open | Maintainer tracking issue asking for developer documentation so apps can move to craft-application without reading source. Partly delivered: docs/ now has how-to, reference and explanation sections, but no tutorial/get-started guide remains. | |
| stealth/space-bunny-alpha |
Impact:
35
Quick Win:
5
Complexity:
45
Confidence:
62
Actionability:
25
|
keep open | Maintainer asks for developer documentation so app developers stop reading craft-application source; docs/ now has 5 how-tos, 9 reference pages and 4 explanation docs, but no migration guide and issue has no maintainer progress comments. | |
| qwen/qwen3.6-35b-a3b |
Impact:
45
Quick Win:
22
Complexity:
30
Confidence:
75
Actionability:
70
|
keep open | Request to add developer documentation for craft-application to reduce the need to read source code when migrating apps. | |
| qwen/qwen3.8-27b |
Impact:
45
Quick Win:
27
Staleness:
70
Complexity:
40
Confidence:
65
Support Request:
10
|
close stale | Request for developer documentation on how to use craft-application, so migrating an app doesn't require reading source. Labeled Type: Documentation, created by a maintainer; only a bot created an internal Jira ticket (CRAFT-2604). The repo now ships a full Diátaxis docs site (how-to, reference, explanation incl. app structure), so the ask is largely addressed. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
95
Complexity:
20
Confidence:
80
Support Request:
5
|
close stale | Request to add developer documentation for craft-application to reduce reliance on reading source code. Currently inactive with no maintainer action or assignee. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
95
Complexity:
10
Confidence:
70
Support Request:
0
|
close stale | Request to add developer documentation for craft-application to reduce reliance on reading source code. Open for over two years with minimal interaction and a stale Jira sync comment. |
Update history
No update history recorded yet.
Related work
-
Related To:
craft-application#1185
(confidence 70%)
Commit4c49d82b 'docs: rework remote build guide (#1185)' plus 7a3a66a3 (#1202) — incremental how-to content addressing this umbrella request.
-
Related To:
craft-application#1144
(confidence 70%)
Commit 50d8cc69 'docs: add a "pack a Pro artifact" how-to (#1144)' — one of the how-to guides fulfilling this issue's goal.
-
Related To:
craft-application#1001
(confidence 65%)
Commit fb2a80ba 'docs: Reference document for the Service Factory (#1001)' (with #999/#1000/#1002) — reference docs added in response to the same documentation gap.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #928 Write documentation describing how to use reusable documentation snippets | craft-application | open | A maintainer-filed, documentation-labeled task to add an app-developer how-to for reusable documentation snippets; the current how-to index has no such guide. |