docs: add badges to the README - #19
Merged
Merged
Conversation
Five shields.io badges under the heading, rather than GitHub's native badge.svg for the two workflows, so the row renders in one consistent style instead of two. Book and Docs stay separate on purpose: the book badge reports a build gate - `strict: true` in mkdocs.yml fails on a broken relative link - while the Docs badge is a doorway to the published site. No version badge. The repo has no tags and declares no version location, so one would either read "no releases" or hardcode a number nothing enforces. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Five shields.io badges under the
# Fleet monitoringheading.actions/workflows/ci.ymlmainactions/workflows/book.ymlmainsite_urlinmkdocs.ymlcollector/pyproject.tomlrequires-python = ">=3.11"LICENSEAll five are shields.io rather than GitHub's native
badge.svgfor the two workflows, so the row renders in one consistent style instead of two. The three dynamic ones were fetched against this repo before committing and returnCI: passing,book: passing,license: MIT— a wrong workflow filename would have rendered "no status".Book and Docs are deliberately separate. The book badge reports a build gate:
strict: trueinmkdocs.ymlturns a broken relative link into a failed build, whichbook.yml's own comments call the most likely way these docs rot. The Docs badge is a doorway to the published site. Different jobs, so both earn a slot — happy to collapse them if you'd rather have four.No version badge. The repo has no tags and declares no version location (no
[tool.bumpversion], no root manifest), so one would either read "no releases" or hardcode a number nothing enforces. Worth adding once that's settled.The Python badge is static — shields has no reader for a nested manifest's
requires-python— so it needs a manual edit if the collector's floor moves. The other four update themselves.Docs-only change:
README.md, +6 lines, no code touched.🤖 Generated with Claude Code