← Back to issue list

Write documentation describing how to use reusable documentation snippets

View original Github issue

Metadata

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

Current evaluation

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.

Suggested action: keep open

Reason: The feature is still in use and undocumented: docs/common/README.md explains the include/replace pattern, and six files (e.g. docs/how-to/build-remotely.rst, docs/reference/models/platforms.rst) consume these snippets, with recent additions like #1144 and #1012. No commit or page has yet written the requested how-to, so the task remains valid; it is a low-complexity docs task that should stay open rather than be closed as stale.

Impact: 25 Quick Win: 20.0 Staleness: 65 Complexity: 20 Confidence: 80 Support Request: 0

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
qwen/qwen3.8-27b
Impact: 25
Quick Win: 20.0
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 15
Confidence: 70
Support Request: 5
close stale Document how app developers include reusable documentation snippets, currently undocumented. Open for 258 days with no comments, awaiting assignment or triage.

Update history

No update history recorded yet.

Related work

  • Related To: craft-application#1012 (confidence 75%)

    Added the platform naming snippet under docs/common, expanding the reusable-snippet set this how-to would document.

  • Related To: craft-application#1144 (confidence 70%)

    Added a 'pack a Pro artifact' how-to that includes a shared snippet from docs/common, showing the pattern is actively used.

Related issues

No related issues found above the similarity threshold.