← Back to issue list

docs: consistentize the READMEs

View original Github issue

Metadata

Project
craft-actions
Number
#136
Type
pull request
State
open
Author
copilot-swe-agent
Labels
—
Created
Updated
Closed
—

Current evaluation

Documentation PR making README files across craft-actions consistent. Under review with 5 unresolved comments, CI passing.

Suggested action: needs review

Reason: The PR updates README consistency across 10 action directories (+55/-25 lines). The author has responded to reviewer @lengau's feedback with commit 6bf251b, but 5 review comments remain unresolved and there are 0 reviewers assigned. The PR is awaiting re-review after addressing feedback.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 15 Complexity: 15 Confidence: 65 Actionability: 60

Issue body

Makes the README files consistent and up to date. Please accept this PR!

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 15
Complexity: 15
Confidence: 65
Actionability: 60
needs review Documentation PR making README files across craft-actions consistent. Under review with 5 unresolved comments, CI passing.
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 11
Complexity: 10
Confidence: 70
Actionability: 60
needs review Documentation PR making README files across craft-actions consistent. Under review with 5 unresolved comments, CI passing.

Update history

Date Change
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#122 docs: add READMEs for each action craft-actions closed PR #122 (CRAFT-5207) merged into craft-actions: added a README per action plus top-level README update, 15 files changed, approved by 2 reviewers with all completed CI checks passing.
82%
#46 docs: split README into one for each action craft-actions merged Merged PR #46 as commit 61c29f2, splitting the monolithic README into per-action READMEs and adopting approved wording from #45.
75%
#4957 Docs: Harmonize README with template snapcraft closed README was harmonized with the Craft model in commit f4d43dcdb (docs: align readme with model), fulfilling the requested documentation cleanup before closure.
74%
#2283 docs: align README with model charmcraft merged Docs-only PR merged as commit 12308dde ("docs: align README with model (#2283)"): rewrote README to match canonical/starbase README template and dropped unused Craft Parts docs, fixing local build errors. 2 files, +79/-49.
72%
#49 Improved README and docs on how to use the lib (CRAFT-707). craft-cli merged Merged in canonical/craft-cli#49 via d5f6567, improving the README and library usage documentation for CRAFT-707 across seven files.
71%
#397 docs: rearrange READMEs starbase merged Merged docs-only PR moving Starbase's rendered README into .github/README.md and the generic template to the root README.md, clarifying the future update workflow. All CI checks passed.
71%