Skip to content

docs(readme): add the corpus-size and ARB queue badges - #128

Merged
mbeacom merged 1 commit into
mainfrom
mbeacom-readme-badges
Aug 12, 2026
Merged

docs(readme): add the corpus-size and ARB queue badges#128
mbeacom merged 1 commit into
mainfrom
mbeacom-readme-badges

Conversation

@mbeacom

@mbeacom mbeacom commented Aug 12, 2026

Copy link
Copy Markdown
Owner

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:

Badge Source Renders
ADRs $.checked from adrkit.dev/lint.json 25
ARB queue $.totalItems from adrkit.dev/queue.json 6 pending

Why 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

GET https://adrkit.dev/lint.json   → 200  {"checked": 25, "findings": []}
GET https://adrkit.dev/queue.json  → 200  totalItems = 6, asOf = 2026-08-12
shields dynamic/json               → "ADRs: 25"  ·  "ARB queue: 6"

Both were rendered through shields against the live URLs before this was written.

One deliberate choice worth surfacing

ARB queue: 6 pending is 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: 25 and keep the badge row at four, say so and I'll drop the queue badge — but I'd argue for keeping it.

Notes

  • No source changes; README and the ADR's action item only.
  • The badge row is now five. If that feels crowded, the License badge is the most redundant of the five (the LICENSE file is one click away and GitHub surfaces it in the sidebar).

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>
Copilot AI balanced review requested due to automatic review settings August 12, 2026 02:44

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@mbeacom mbeacom self-assigned this Aug 12, 2026
@mbeacom
mbeacom merged commit a43fac2 into main Aug 12, 2026
11 checks passed
@mbeacom
mbeacom deleted the mbeacom-readme-badges branch August 12, 2026 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants