← 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 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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update splitting the monolithic README into individual files for each action. Content was adapted from existing text and updated phrasing from PR #45 to improve repository organization.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#397 docs: rearrange READMEs starbase merged Merged documentation update rearranging READMEs to clarify the fork workflow. The main README was moved to .github/ for GitHub rendering priority, while the template stays at the root. Approved by two reviewers and passed all CI checks.
77%
#10 docs: improve README snapcraft-rocks merged Merged documentation update improving the README. Approved by two reviewers, adding 66 lines and removing one across a single file.
76%
#387 docs: add readme template starbase merged Merged after approval by two reviewers and successful CI checks. The pull request introduced a README template, adding 73 lines and removing 7 across two files to standardize project documentation.
72%
#1052 docs: Update README.md contributing link rockcraft merged Merged a documentation update fixing a broken contributing link in README.md to point to CONTRIBUTING.md. Approved by three reviewers, passed CI checks, and applied as a single-line change.
72%
#5348 docs: align readme with model snapcraft merged Merged documentation update aligning the README with the internal model documentation. Resolves issue #4957. Approved by three reviewers, adding 107 lines and removing 18 across two files.
71%
#331 docs: fix spacing errors in README starbase merged Merged documentation changes fixing missing newlines in the README that prevented proper markdown ordered sub-list rendering. Approved by two reviewers, passed CI, and applied with a +5/-0 line change.
71%
#286 Update README.md charmcraft merged Merged following terminology updates to README.md. Approved by three reviewers with no unresolved comments. The commit altered 13 lines across one file. No CI checks were required.
71%
#1582 docs: correct the 'organize' description craft-parts merged Merged a documentation update correcting the 'organize' description. Approved by two reviewers with a three-line change across one file. Successfully integrated after passing required checks.
71%
#1302 docs: rewrite some redirects craft-parts merged Merged documentation rewrite correcting several redirects to resolve recurring lint CI failures. Approved by two reviewers, passed all CI checks, and modified four files with minimal changes.
70%
#142 refactor(docs): separate documentation pages craft-store merged Merged after two reviewer approvals and passing CI. The change refactored documentation by separating pages across eight files, adding 426 and removing 418 lines. All guidelines and checks were satisfied.
70%