← Back to issue list

docs(readme): add readthedocs build badge

View original Github issue

Metadata

Project
snapcraft
Number
#4350
Type
pull request
State
merged
Author
mr-cal
Labels
Created
Updated
Closed

Current evaluation

Merged adding a ReadTheDocs build status badge to the README. Approved by two reviewers, passed CI, modified one file (+4/-1), and left coverage unchanged.

Suggested action:

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? - [x] Have you successfully run `pytest tests/unit`? ----- Add build status badge for readthedocs. I broke the badges into multiple lines for readability. Preview here: https://github.com/snapcore/snapcraft/tree/docs-badge#readme

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged adding a ReadTheDocs build status badge to the README. Approved by two reviewers, passed CI, modified one file (+4/-1), and left coverage unchanged.
qwen3.6-35b-a3b-mtp-q6 Merged into main. Added a ReadTheDocs build status badge to the README. Documentation-only changes resulted in no coverage impact.
qwen3.6-35b-a3b-mtp-q6 Merged into main. Added a ReadTheDocs build status badge to the README, split across multiple lines for readability. Code coverage remained unchanged.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#555 docs(readme): add readthedocs build badge craft-parts merged Merged a maintainer-submitted update adding a ReadTheDocs build badge to the README. Approved by two reviewers, passed CI checks, and applied with minimal changes (+2/-0 lines).
94%
#203 docs(readme): add badges starbase merged Merged. Added badges to the README. Initial sphinx-lint line-length failures for URLs were resolved after upstream starbase changes fixed the linting rules, allowing the documentation update to pass CI and merge.
75%
#193 docs: rework badges imagecraft merged Merged documentation badge updates. Removed broken badges and added new ones for codecov, ruff, and snap. Approved by three reviewers and passed all continuous integration checks.
74%
#1505 docs: make badges only use what's actually on main charmcraft merged Merged a documentation update restricting status badges to the main branch only. This prevents open pull requests with failing tests from incorrectly displaying as failures. Approved by three reviewers, passed CI, and modified one file.
74%
#387 readme: update readthedocs link craft-parts merged Merged a single-file update to the README that corrected the ReadTheDocs documentation link. The change received approval from one reviewer, had no unresolved comments, and required no CI checks.
73%
#103 docs: new link to docs craft-store merged Merged after approval. Updated README.md to add a documentation link and badge, resolving issue #101. The single-file change added three lines and removed one. The pull request passed review and CI checks without blocking the merge.
72%
#1410 chore: add badges to readme charmcraft merged Merged changes adding badges to the README. Approved by two reviewers with zero unresolved comments. Updated one file with 11 additions and 6 deletions.
72%
#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.
72%
#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.
72%
#219 docs: fix readthedocs documentation generation craft-parts merged Merged. Resolved ReadTheDocs build failures by installing missing environment packages, adding the changelog to the documentation index, and removing python-apt from setup to prevent version conflicts. Approved and passed CI.
71%