[JUJU-4554] Update the README to simplify and better align with docs
Metadata
Current evaluation
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).
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged an updated README simplifying the introduction and aligning with broader Juju ecosystem documentation. Changes incorporated feedback on contextual framing and Multipass mentions before approval. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2168 docs: update readme and logo | charmcraft | merged | Merged documentation update replacing the Ubuntu circle logo with the Juju logo on RTD docs and correcting the README link. Approved by two reviewers, passed CI, and resolved a file copying issue prior to merge. | |
| #2136 docs: fix broken references to juju docs | charmcraft | merged | Merged after three reviewer approvals. Corrected broken references to Juju documentation across four files with a six-line addition and six-line removal. The update depends on juju/juju#18790. | |
| #2095 docs: update Juju links | charmcraft | merged | Merged documentation update modifying Juju links and formatting across 16 files. Approved by two reviewers and passed CI checks. Implements a partial update for issue #2090. | |
| #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. |