docs: show the release as a badge instead of naming it in prose - #13
Closed
kkdev92 wants to merge 1 commit into
Closed
docs: show the release as a badge instead of naming it in prose#13kkdev92 wants to merge 1 commit into
kkdev92 wants to merge 1 commit into
Conversation
The status line said `0.1.0`. That is correct today and wrong the day the next release is tagged, and nothing fails in between -- the reader is the one who finds out. Unlike the other repositories here, this one had no version badge to fall back on: it is firmware rather than a published package, so removing the number would have removed the information. A release badge replaces it. It reads from the repository's own releases, so it cannot disagree with them. Verified: the badge resolves and renders `v0.1.0`, which is the current tag. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013Tfbt5Vy1jB9C6mMAHXhLY
Owner
Author
|
Closed as wrong. The That last clause is the point. The version in the README is not a label on the page — it is the value the firmware reports over the wire, so the README and the device would have disagreed. Removing it defeats a check that exists for a reason. |
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.
Replaces the hand-written version in the status line with a release badge.
Why
The status line said
0.1.0. That is accurate today and wrong the day the nextrelease is tagged, and nothing fails in between — the reader is the one who
finds out.
Why a badge rather than just deleting it
The sibling repositories all carry a package-registry badge, so removing the
number from their prose loses nothing. This one is firmware, not a published
package, so there was no badge to fall back on — deleting the number would have
removed the information rather than moved it.
A GitHub release badge reads from this repository's own releases. It cannot
disagree with them, and it needs no maintenance.
Verification
The badge URL resolves and renders
v0.1.0, which is the current tag.🤖 Generated with Claude Code