← Back to issue list

docs: split README into one for each action

View original Github issue

Metadata

Project
craft-actions
Number
#46
Type
pull request
State
merged
Author
bepri
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #46 as commit 61c29f2, splitting the monolithic README into per-action READMEs and adopting approved wording from #45.

Resolution: closed resolved

Reason: The documentation refactor was merged in commit 61c29f2 with all CI checks passing. It created one README per action and incorporated approved language from PR #45.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This PR splits the monolithic README into one README for each available action. In all cases, I either copied existing language directly into the new README or, where applicable, updated it to use the most recently approved phrasing from #45. This is probably easiest to review by browsing the repository starting at the top-level README: https://github.com/canonical/craft-actions/tree/work/refactor-docs/CRAFT-4927 CRAFT-4927

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #46 as commit 61c29f2, splitting the monolithic README into per-action READMEs and adopting approved wording from #45.
stealth/space-bunny-alpha — closed resolved Merged as 61c29f2 (CRAFT-4927, 4 approvals, all CI green): the monolithic README was split into per-action READMEs under snapcraft/, rockcraft/ and charmcraft/, with wording aligned to #45. Top-level README now links to each action's doc.
stealth/space-bunny-alpha — closed resolved Merged canonical/craft-actions#46 as 61c29f2, splitting the monolithic README into per-action READMEs and incorporating approved wording from #45.
qwen/qwen3.6-35b-a3b — — Merged documentation refactor splitting the monolithic README into individual files for each action. Approved by four reviewers, passed all CI checks, and modified seven files to improve organization and align with recent phrasing updates.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-actions#45 (confidence 98%)

    Its approved action wording was incorporated into the new per-action READMEs.

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.
78%
#136 docs: consistentize the READMEs craft-actions open Documentation PR making README files across craft-actions consistent. Under review with 5 unresolved comments, CI passing.
75%