From bde2671a93c729d92cd7314d59dd1f097c090ed6 Mon Sep 17 00:00:00 2001 From: Mark Beacom Date: Tue, 11 Aug 2026 22:44:11 -0400 Subject: [PATCH] docs(readme): add the corpus-size and ARB queue badges MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.md | 2 ++ ...025-ship-badges-as-recipes-over-existing-output.md | 11 ++++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 17850ff0..ebd1f226 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ without leaving git. [![npm version](https://img.shields.io/npm/v/@adrkit/cli?logo=npm&label=%40adrkit%2Fcli)](https://www.npmjs.com/package/@adrkit/cli) [![CI](https://github.com/mbeacom/adrkit/actions/workflows/ci.yml/badge.svg)](https://github.com/mbeacom/adrkit/actions/workflows/ci.yml) +[![ADRs](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fadrkit.dev%2Flint.json&query=%24.checked&label=ADRs&color=cb492d)](./docs/adr) +[![ARB queue](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fadrkit.dev%2Fqueue.json&query=%24.totalItems&label=ARB%20queue&suffix=%20pending&color=cb492d)](./docs/adr) [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE) Most ADR tooling is a markdown template and a static site generator. That diff --git a/docs/adr/0025-ship-badges-as-recipes-over-existing-output.md b/docs/adr/0025-ship-badges-as-recipes-over-existing-output.md index 31ee8a53..0a404834 100644 --- a/docs/adr/0025-ship-badges-as-recipes-over-existing-output.md +++ b/docs/adr/0025-ship-badges-as-recipes-over-existing-output.md @@ -350,11 +350,12 @@ an artifact claim more than it can support — but readers will over-read it. ## Action items -1. [ ] Add the queue badge to `README.md` once `https://adrkit.dev/queue.json` - is live, verifying the render end to end at that point — the shields mechanism and both failure - renders were observed, and the first-run/no-change/changed paths of the - adopter recipe were executed, but the deployed path cannot be exercised - until this merges and the site publishes (ADR-0016). +1. [x] Add the badges to `README.md` once the reports are live, verifying the + render end to end at that point. Done: `https://adrkit.dev/lint.json` and + `/queue.json` both return HTTP 200 from the first post-merge deploy, and + shields renders `ADRs: 25` and `ARB queue: 6` against them. This closes + the last claim in this record that had been reasoned rather than observed + (ADR-0016). 2. [x] Fix the badge's brand color against the site palette — resolved to `#cb492d` / `#1d1311`, converted from `site/src/styles/custom.css`. 3. [x] Publish `lint.json` alongside `queue.json` from the site build, and