docs: align README with model
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update aligning the README with the model and resolving local build errors from unused Craft Parts documentation. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1199 docs: update README according to template | craft-parts | merged | Merged after two approvals and passing CI. Updates the README to align with a standard template, heavily inspired by Craft Application, modifying one file with 40 additions and 11 deletions. | |
| #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. | |
| #49 Improved README and docs on how to use the lib (CRAFT-707). | craft-cli | merged | Successfully merged documentation updates improving the README and library usage guide. Approved by one reviewer, modified seven files with 582 additions and 10 deletions, resolving CRAFT-707. | |
| #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. | |
| #2186 docs: fix build errors | charmcraft | merged | Merged a one-line documentation fix to resolve recent build errors. Approved by two reviewers. Remaining build issues were subsequently addressed in craft-parts pull request 1021. | |
| #114 docs: update readme information | debcraft | merged | Merged after two approvals and passing CI checks. Updates the README with basic usage information consistent with other craft tools, resolving DEBCRAFT-25. Review feedback was incorporated prior to merge. | |
| #2070 docs: fix build errors in craft-parts | charmcraft | closed | Merged to resolve documentation build errors in craft-parts. Changes fix ref and label issues, with some dependencies on an upstream PR. Integrated directly by the maintainer without reviewer comments or CI checks. | |
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83). | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage. | |
| #404 docs: add an explanation of parts | craft-parts | merged | Merged documentation update explaining parts, adding 628 lines across nine files. Approved by one reviewer, references CRAFT-1612, and was finalized after initial feedback collection. |