Docs: link to examples in each action's README
Metadata
Current evaluation
Docs request by a maintainer to add real-world usage examples to each action's README (like setup-uv), also to help users choose between setup and pack actions; still open, no discussion.
Suggested action: keep open
Reason: The issue is valid, maintainer-authored (jahn-junior) and carries the 'Type: Documentation' label, so it is triaged. Verification of snapcraft/setup/README.md and snapcraft/pack/README.md at the pinned HEAD shows only Usage/Inputs/Outputs sections with no examples, and grep for 'Examples', 'Used by', and 'real-world' plus git log for 'examples' return nothing, so it is unresolved. It is scoped to docs across all ~8 action directories with an explicit reference implementation (astral-sh/setup-uv), though the specific projects to cite and the disambiguation wording for setup vs pack are left to the author, which caps actionability and confidence.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
30
Quick Win:
15
Complexity:
22
Confidence:
78
Actionability:
65
|
keep open | Docs request by a maintainer to add real-world usage examples to each action's README (like setup-uv), also to help users choose between setup and pack actions; still open, no discussion. | |
| qwen/qwen3.6-35b-a3b |
Impact:
35
Quick Win:
18
Complexity:
25
Confidence:
85
Actionability:
70
|
keep open | Documentation request to add real-world examples to each action's README, similar to astral-sh/setup-uv, to help users choose between setup and pack actions. | |
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
24
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. |
Update history
No update history recorded yet.
Related work
-
Related To:
craft-actions#46
(confidence 80%)
Commit 61c29f2 'docs: split README into one for each action (#46)' created the per-action READMEs this issue would extend; filed immediately after by the same author.
-
Related To:
craft-actions#122
(confidence 70%)
Commit 751215e 'docs: add READMEs for each action (#122)' shows READMEs continue to be maintained, but the example sections requested here are still absent.
Related issues
No related issues found above the similarity threshold.