docs: align README with model
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: The PR itself was merged into the main branch by maintainer jahn-junior after approval by 2 reviewers, landing as commit 12308dde in the README.md history. The README on main now follows the Starbase model structure (Badges, Basic usage, Installation, Documentation, Community and support).
Evaluated by: mr-cal-bot
No scores available.
Issue body
* align README with the [model](https://github.com/canonical/starbase/blob/main/README-template.md?plain=1)
* drive-by: resolve local build errors from unused Craft Parts docs
[README preview](https://github.com/canonical/charmcraft/blob/3fbe5291147552be4903d76959a61ebba2a1e096/README.md)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged documentation updates aligned Charmcraft’s README with the Starbase model and removed unused Craft Parts docs, resolving local build errors. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #2283 (commit 12308dde), aligning the README with Starbase’s model and fixing local build errors from unused Craft Parts docs. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2283 (12308dde), aligning README with the Starbase model and removing unused Craft Parts docs that caused local build errors. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged after approval. The update aligned the project README with the official template and resolved local build errors caused by unused Craft Parts documentation. Two files were modified, resulting in 79 additions and 49 deletions. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged by maintainer jahn-junior. Aligned the README with the model and fixed local build errors caused by unused Craft Parts documentation. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #233 Docs: Add README template | starbase | closed | Added the Craft project README template in merged PR canonical/starbase#387 (commit afc6663), covering Markdown setup, installation, builds, licensing, and contribution links. | |
| #785 fix: remove Starbase README | craft-application | merged | PR #785 merged as commit d6b706a3, deleting the 144-line Starbase-rendered .github/README.md from craft-application. Approved by 2 reviewers; lint/tests/builds passed (OSV-scanner failed, non-blocking). | |
| #5348 docs: align readme with model | snapcraft | merged | Merged PR canonical/snapcraft#5348 in commit f4d43dcdb, aligning the README with Snapcraft's project model and resolving #4957. | |
| #336 docs: fix some formatting errors in README | starbase | merged | Docs-only PR merged as commit d3d4189, adding 10 lines to starbase's README to fix spacing/formatting errors that slipped past the earlier README cleanup in #331 (commit de0d308). Approved by 2 reviewers, no CI. | |
| #1929 Docs: Harmonize README with template | charmcraft | open | README harmonization with Starbase template. Blocking dependency starbase#233 closed; PR #2283 aligned README with the model. Work appears complete but issue remains open. | |
| #443 docs: adopt standard README model | imagecraft | closed | Merged as commit 59f3e49 "docs: adopt standard README model (#443)" by maintainer jahn-junior, rewriting README.md (+27/-25) with standard product usage/installation copy; all CI checks passed. | |
| #1197 docs: align `CONTRIBUTING.md` with template | craft-parts | merged | Merged docs-only PR #1197 (commit 41cbe718) aligning CONTRIBUTING.md with the craft project template, +147/-89 lines; follow-up to earlier CONTRIBUTING work in #1134/#1142. | |
| #2353 docs: update `CONTRIBUTING.md` | charmcraft | merged | Docs-only PR #2353 merged as commit 62abb2f4, replacing CONTRIBUTING.md with shared Starcraft guidance (+257/-58 across 2 files) and dropping a misplaced README link; approved by 2 reviewers. |