docs: update readme and template, fix build error
Metadata
Current evaluation
Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build.
Resolution: closed resolved
Reason: The approved PR was merged as commit 7d2790e. Its changes clarified documentation, expanded preparation instructions, and temporarily disabled failing PDF and EPUB builds.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- Clarify the wording in the README, add more details about preparing the docs.
- Disable PDF and EPUB generation. We can re-enable this later when we rebase the docs and those builds are working again.
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox`?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #258: clarified README documentation, expanded doc-preparation guidance, and disabled PDF/EPUB builds to fix the build error. Approved by two reviewers. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged by maintainer medubelko. Updated README wording and documentation details, fixed a build error, and temporarily disabled PDF and EPUB generation. Codecov verified 100% test coverage for all modified lines. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1199 docs: update README according to template | craft-parts | merged | README documentation was updated to match the standard template; PR #1199 was merged via commit ef4d4fff. | |
| #387 docs: add readme template | starbase | merged | Merged PR #387 added a README template, landing as commit afc6663 after two approvals and with all listed CI checks passing. | |
| #669 Docs: Add build instructions to README | rockcraft | closed | README build instructions were addressed by merged PR #925 (commit 3d63a806), and the maintainer marked the request fixed. | |
| #219 docs: fix readthedocs documentation generation | craft-parts | merged | Merged PR #219 (commit c70294ee, merge 996ed24e) fixed RTD doc builds: added missing packages to the readthedocs env, indexed the changelog, and removed outdated python-apt from setup.py. Shipped in release 1.7.0. | |
| #152 docs: add additional info to readme | craft-parts | merged | Merged #152, adding README instructions for tests, dependency freezing, local documentation generation, and commit-message guidelines; content commit 828c9543. | |
| #2217 docs: rewrite home page | charmcraft | merged | Merged PR #2217 in commit 9f3d6ebd, rewriting the documentation home page to the standard model and fixing reference-doc lint errors; remaining feedback was deferred. | |
| #54 fix(docs): make readthedocs build correctly | craft-platforms | merged | Merged PR #54 via commit 16406ff, correcting the Read the Docs configuration so the documentation builds successfully. | |
| #346 docs: update README | craft-providers | merged | Docs-only PR by maintainer mr-cal fixing README formatting and adding links; approved and squash-merged into main as commit 889a2cf "docs: update README (#346)" (+7/-2 lines in README.rst). | |
| #6295 docs: fix version numbering | snapcraft | merged | Merged #6295 (commit 8456b4421), fixing docs version numbering to use Read the Docs branch metadata and keep local and RTD builds consistent. | |
| #6387 docs: fix version on 'latest' | snapcraft | merged | Merged PR #6387 via commit a67bdcd1f, fixing docs titles to show major.minor for local, PR, and branch builds while displaying dev for latest. |