Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbeacom merged 1 commit into from
Aug 12, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 6 additions & 5 deletions docs/adr/0025-ship-badges-as-recipes-over-existing-output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down