Badge Catalog¶
docs/badges.md is the single source of truth for shared badge templates across
the managed documentation surfaces in this repository. Update the named
templates here, then run make sync-badges so the root README, the docs
landing page, and the managed package README surfaces publish the same badge
contract.
Do not hand-edit badge blocks inside managed surfaces. Those files consume the templates below through generated badge sections.
If a README surface needs package links outside the managed badge section, use plain markdown links or icon links instead of inline badge markdown.
Generated badge sections always render in this order:
- surface summary badges when the surface owns them
- one line of
PyPIbadges for every public package - one line of
GHCRbadges for every public package - one line of
Documentationbadges for every public package
Link policy for GHCR badges is fixed here as part of the contract:
- the repository-wide GHCR summary badge links to
https://github.com/bijux?tab=packages - per-package GHCR badges link to the package-specific
https://github.com/bijux/bijux-proteomics/pkgs/container/...page