← 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 PR #4350, adding a Read the Docs build-status badge to the README and splitting badges onto separate lines (commit dda73543f).

Resolution: closed resolved

Reason: The documentation update was merged through PR #4350 and recorded as commit dda73543f. The README now displays the documentation build status.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Merged PR #4350, adding a Read the Docs build-status badge to the README and splitting badges onto separate lines (commit dda73543f).
stealth/space-bunny-alpha — closed resolved Merged docs PR #4350 by maintainer mr-cal added a Read the Docs build status badge to README.md (split badges onto separate lines), landing as commit dda73543f "docs: add build status badge".
stealth/space-bunny-alpha — closed resolved Merged PR #4350 added a Read the Docs build-status badge to the README, arranging badges across multiple lines for readability.
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.

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 PR #555 in commit 0db20448, adding a Read the Docs build-status badge to the README.
96%
#392 docs(readme): add readthedocs build badge craft-providers merged PR #392 by mr-cal was merged (commit b0b9750), adding a readthedocs.org build-status badge to README.md. Author also noted the docs build was failing.
89%
#203 docs(readme): add badges starbase merged Merged PR #203 (commit 76f2dbd) added tests/docs/coverage badges to starbase's README, fixing #180 after sphinx-lint line-length failures were resolved by merged PR #221 (1d72f49).
82%
#470 docs(readme): add weekly test and code coverage badges craft-providers merged Merged PR #470 added weekly test and code coverage badges to the README in commit a5fc284.
78%
#469 docs(readme): add status badge for weekly tests craft-providers closed Closed unmerged as the README update was superseded by PR #470, which added weekly-test and coverage badges and merged as commit a5fc284.
77%
#193 docs: rework badges imagecraft merged PR #193 merged as commit dea806e ("docs: rework badges"): dropped broken README badges and added Codecov coverage, Ruff and Snap Store badges, +16/-8 lines in README.md.
77%
#89 Add GitHub badges to README craft-platforms closed Badges added to README via the Starbase README template in merged PR #140 (commit 376010f). README now shows QA (qa.yaml, the requested one), ReadTheDocs, PyPI, Ruff and Security scan badges.
73%