docs: update readme and template, fix build error
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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 |
|---|---|---|---|---|
| #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. | |
| #2860 docs: fix copy error in README | charmcraft | merged | Merged after passing all CI checks and receiving approval from two reviewers. Resolved a copy error in the README with a minimal one-line change. | |
| #826 docs: update CONTRIBUTING.md | craft-application | merged | Merged documentation update aligning CONTRIBUTING.md with the official template. Approved by three reviewers with all CI checks passing. The change modifies one file with 104 additions and 48 deletions. | |
| #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. | |
| #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. | |
| #2299 docs: fix formatting issues | charmcraft | merged | Merged documentation formatting fixes resolving local build errors. Approved by two reviewers with minimal changes (+3/-1 across two files). Merged despite failing snap-build CI checks. | |
| #368 docs: update CONTRIBUTING.md | craft-cli | merged | Merged following two reviewer approvals and successful CI checks. Updates CONTRIBUTING.md to align with the standard template, applying 107 additions and 55 deletions to a single file. | |
| #152 docs: add additional info to readme | craft-parts | merged | Merged documentation update adding README instructions for running tests, freezing requirements, generating local documentation, and commit guidelines. Approved by one reviewer, passed CI checks, and added 61 lines to a single file. | |
| #9 docs: update build procedure and fix warning | craft-store | merged | Merged updates consolidate API documentation configuration in conf.py for ReadTheDocs and fix a build warning. Approved by one reviewer, passed CI, and notes propagation to related craft-* projects. | |
| #331 docs: fix spacing errors in README | starbase | merged | Merged documentation changes fixing missing newlines in the README that prevented proper markdown ordered sub-list rendering. Approved by two reviewers, passed CI, and applied with a +5/-0 line change. |