docs(readme): add the corpus-size and ARB queue badges - #128
Merged
Conversation
Closes ADR-0025 action item 1, which could not be exercised until the site published the reports. Both are now live — `adrkit.dev/lint.json` and `/queue.json` return HTTP 200 from the first post-merge deploy — and shields renders `ADRs: 25` and `ARB queue: 6` against them. They were deliberately held back from the badge PR: the URLs did not exist until that merged, so shipping them together would have put error tiles on this project's front page, which is the failure the record exists to avoid. `ARB queue` is shown rather than hidden even though six records have been awaiting review since July. A queue badge that only ever reads zero would be decoration; the number is worth showing precisely when it is not comfortable. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Mark Beacom <m@beacom.dev>
There was a problem hiding this comment.
Pull request overview
Adds live corpus-size and ARB queue-depth badges, completing ADR-0025’s remaining action item.
Changes:
- Adds ADR and pending queue badges to the README.
- Records successful end-to-end verification in ADR-0025.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
README.md |
Adds both dynamic JSON badges. |
docs/adr/0025-ship-badges-as-recipes-over-existing-output.md |
Marks the badge action item complete with verification evidence. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
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
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.
Closes ADR-0025 action item 1 — the last claim in that record that had been reasoned rather than observed.
What this adds
Two badges to the README, both reading JSON the site now publishes:
ADRs$.checkedfromadrkit.dev/lint.jsonARB queue$.totalItemsfromadrkit.dev/queue.jsonWhy this is a separate PR
The URLs did not exist until #127 merged and the site deployed. Shipping the badges in that PR would have put two error tiles on this project's front page — the exact failure ADR-0025 exists to avoid — so the record tracked it as an open action item instead.
Verified end to end, not reasoned
Both were rendered through shields against the live URLs before this was written.
One deliberate choice worth surfacing
ARB queue: 6 pendingis not a flattering number — those six records (0003, 0005–0009) have been awaiting review since July. It is shown anyway. A queue badge that only ever reads zero is decoration; the number earns its place precisely when it is uncomfortable, and a tool whose thesis is that decision records must not lie should not hide its own backlog.If you'd rather ship only
ADRs: 25and keep the badge row at four, say so and I'll drop the queue badge — but I'd argue for keeping it.Notes
Licensebadge is the most redundant of the five (the LICENSE file is one click away and GitHub surfaces it in the sidebar).