Write documentation describing how to use reusable documentation snippets
Metadata
Current evaluation
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.
Suggested action: keep open
Reason: The task is explicitly scoped to writing a how-to, is authored by a maintainer, and carries the Type: Documentation label, indicating that it has been triaged. The open docs/how-to/index.rst lists five guides but no reusable-snippet guide, so the reported documentation gap remains in the current tree.
Evaluated by: mr-cal-bot
Impact:
40
Quick Win:
23
Complexity:
30
Confidence:
90
Actionability:
82
Issue body
### What needs to get done
Write a how-to for app developers showing how to include reusable documentation snippets in their app
### Why it needs to get done
This is currently undocumented
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
40
Quick Win:
23
Complexity:
30
Confidence:
90
Actionability:
82
|
keep 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. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
19
Complexity:
20
Confidence:
85
Actionability:
80
|
keep open | Documentation task to create a how-to guide for app developers on using reusable documentation snippets in craft-application | |
| qwen/qwen3.8-27b |
Impact:
25
Quick Win:
20
Staleness:
65
Complexity:
20
Confidence:
80
Support Request:
0
|
keep open | Docs task: write a how-to for app developers on including Craft Application's reusable documentation snippets (docs/common). Open 334 days, no comments; snippets are actively used but the how-to is still missing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
20
Confidence:
80
Support Request:
10
|
needs triage | Documentation task outlining how app developers can include reusable snippets. Currently undocumented and unassigned. No maintainer comments or activity in 293 days. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
15
Confidence:
80
Support Request:
5
|
needs triage | Task to document how app developers can include reusable documentation snippets. Currently undocumented and has seen no activity or maintainer response in 280 days. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #110 docs: Add developer documentation | craft-application | 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. |