← Back to issue list

Docs: link to examples in each action's README

View original Github issue

Metadata

Project
craft-actions
Number
#47
Type
issue
State
open
Author
jahn-junior
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

Docs enhancement to add real-world usage examples to each action's README (setup, pack) to help users disambiguate between them. Labeled Type: Documentation, filed by a maintainer, no comments or PRs referencing it in 263 days.

Suggested action: keep open

Reason: The issue is triaged (labeled Type: Documentation), filed by maintainer jahn-junior, and the documentation gap it describes still exists — grep confirms no 'Examples' section in any action README. The repo remains active (recent commits #100, #101), so the issue is not outdated. Inactivity alone (~8.5 months) is insufficient to close a valid, scoped doc improvement.

Impact: 30 Quick Win: 24.0 Staleness: 55 Complexity: 20 Confidence: 75 Support Request: 10

Issue body

It'd be beneficial to users if we showed real-world uses of each action, similar to the [astral-sh/setup-uv README](https://github.com/astral-sh/setup-uv/blob/main/README.md?plain=1#L35-L36). This would also help to disambiguate the setup and pack actions, as we don't do much to guide users in picking between the two.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 30
Quick Win: 24.0
Staleness: 55
Complexity: 20
Confidence: 75
Support Request: 10
keep open Docs enhancement to add real-world usage examples to each action's README (setup, pack) to help users disambiguate between them. Labeled Type: Documentation, filed by a maintainer, no comments or PRs referencing it in 263 days.
qwen/qwen3.6-35b-a3b
Staleness: 65
Complexity: 15
Confidence: 80
Support Request: 0
needs triage Suggests adding real-world usage examples to each action's README to help users choose between setup and pack actions. Unaddressed for over seven months with no maintainer comments.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 10
Confidence: 85
Support Request: 0
needs triage Suggests adding real-world usage examples to each action's README to improve user guidance and clarify the difference between setup and pack actions. Currently unaddressed with no maintainer comments after 209 days.
qwen3.6-35b-a3b-mtp-q6
Staleness: 70
Complexity: 5
Confidence: 85
Support Request: 0
keep open Add real-world examples to each action README to clarify usage and distinguish between setup and pack actions. Currently open, unassigned, and inactive for 187 days. Requires documentation updates and triage.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.