← Back to issue list

[JUJU-4554] Update the README to simplify and better align with docs

View original Github issue

Metadata

Project
charmcraft
Number
#1341
Type
pull request
State
merged
Author
tmihoc
Labels
—
Created
Updated
Closed

Current evaluation

Docs-only PR merged as commit 647a605c (#1341): rewrote Charmcraft's README (+62/-118) to a shorter intro placing Charmcraft in the Juju/Charm SDK ecosystem and linking to Charm SDK docs instead of Multipass install steps.

Resolution: closed resolved

Reason: The PR itself was the fix and was merged: commit 647a605c 'docs: update the README to simplify and better align with docs (#1341)' appears in charmcraft's README.md history, touching only that file with approved review from 2 reviewers.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This is part of a bigger initiative to update the READMEs for all the Juju-universe projects. The goal is to have a simpler, more to the point intro that provides better context and a better integration with the docs.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs-only PR merged as commit 647a605c (#1341): rewrote Charmcraft's README (+62/-118) to a shorter intro placing Charmcraft in the Juju/Charm SDK ecosystem and linking to Charm SDK docs instead of Multipass install steps.
stealth/space-bunny-alpha — closed resolved Merged #1341 as commit 647a605c, simplifying Charmcraft's README and aligning its introduction and usage guidance with the wider Juju and Charm SDK documentation.
stealth/space-bunny-alpha — closed resolved Merged #1341 in commit 647a605c, simplifying Charmcraft’s README and aligning its Juju ecosystem context and documentation guidance.
stealth/space-bunny-alpha — closed resolved Merged as commit 647a605c via #1341, simplifying Charmcraft’s README and aligning its overview and setup guidance with the Juju ecosystem and Charm SDK documentation.
qwen/qwen3.6-35b-a3b — — Merged after two reviewers approved. Simplified the README and aligned it with broader Juju ecosystem documentation, addressing feedback on context framing and installation steps. Changed one file (+62/-118 lines).
qwen3.6-35b-a3b-mtp-q6 — — Merged an external update simplifying the README and aligning it with broader Juju ecosystem docs. Feedback on context versus Charmcraft specificity was addressed by keeping the ecosystem table and teaser sections to guide users to related projects.

Update history

No update history recorded yet.

Related work

  • Related To: juju#16478 (confidence 60%)

    Author cites the sibling Juju README PR as the parallel companion change in the same Juju-universe README initiative (JUJU-4554).

  • Related To: operator#1052 (confidence 60%)

    Companion Ops README PR referenced by the author for the shared ecosystem table/'You are here' pattern.

  • Related To: canonical/charmcraft#1410 (confidence 40%)

    Preceding README change (badges) landed just before this one, 647a605c's parent in README.md history.

Related issues

Issue Project State Summary Similarity
#2135 Docs: Broken references to Juju charmcraft closed Fixed by merged PR charmcraft#2136 in commit fe64df47, correcting six broken Juju documentation references across four files.
73%
#817 docs(README): Replace obsoleted build command charmcraft merged Merged PR #817 updated the README to use charmcraft pack instead of the removed charmcraft build command for Charmcraft 2.0.0.
73%
#2128 docs: add anchors and fix a few small things charmcraft merged Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charms, _initialise-a-charm) for Ops/Juju linking, retitled 'Set up Charmcraft' to 'Manage Charmcraft', expanded content, and fixed a rendering error.
72%
#188 Small text cleanups for README and charmcraft help charmcraft merged Merged README and charmcraft help-text cleanups in ffc44697, updating 13 files after approval by two reviewers.
71%
#2095 docs: update Juju links charmcraft merged Merged in canonical/charmcraft#2095 (commit 389f8ca5), updating Juju links and related formatting across 16 files as the rST portion of #2090.
71%
#275 pack README.md and require README.md in uploaded bundle charmcraft closed Fixed by merged PR #298: charmcraft pack now requires/includes README.md in bundles, satisfying Juju's validation (commit 185866f7, merge 65d735b0).
71%
#143 New release (and improved howto). charmcraft merged Merged in charmcraft#143 (change d5570668, merge 90ae3562), releasing Charmcraft 0.4.0 and improving the release how-to documentation.
70%