Skip to content

Badge Catalog

docs/bijux-atlas-dev/governance/badge-catalog.md is the shared badge catalog for Atlas README and documentation surfaces.

Use this page as the reference point when badge blocks change so the repository root, docs landing, and maintainer-facing surfaces stay consistent about what Atlas publishes and how those surfaces link out.

Do not add one-off badge styles or ad hoc badge destinations in public-facing surfaces. Reuse the catalog patterns here so repository, runtime, and maintainer badges keep one contract.

Atlas is Rust-first, so the catalog focuses on:

  • repository workflow badges
  • crates.io and docs.rs badges for the public runtime crate
  • GHCR release-bundle badges for the published Atlas crate family
  • documentation badges for the canonical bijux-atlas* handbooks
  • maintainer summary badges for repository governance and docs delivery

Repository Summary

Rust 1.86+ License: Apache-2.0 CI Docs Crates Publish GHCR Publish GitHub Release Release GHCR packages Published packages

Runtime Package Summary

These templates are source examples. Replace every placeholder before publishing a badge block in a package README or handbook.

<!-- bijux-atlas-badges:runtime-package-summary:start -->
[![Rust 1.86+](https://img.shields.io/badge/rust-1.86%2B-DEA584?logo=rust&logoColor=white)]({{ crate_registry_url }})
[![crates.io](https://img.shields.io/crates/v/{{ crate_name }}?logo=rust)]({{ crate_registry_url }})
[![rust-docs](https://img.shields.io/badge/rust--docs-{{ crate_badge_label }}-DEA584?logo=rust&logoColor=white)]({{ crate_docs_url }})
[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-0F766E)](https://github.com/bijux/bijux-atlas/blob/main/LICENSE)
[![GitHub Repository](https://img.shields.io/badge/github-bijux%2Fbijux--atlas-181717?logo=github)](https://github.com/bijux/bijux-atlas)
<!-- bijux-atlas-badges:runtime-package-summary:end -->

Maintainer Summary

Rust 1.86+ License: Apache-2.0 Docs Docs Audit Ops Validate

Runtime Crate Badge

<!-- bijux-atlas-badges:family-crate-badge:start -->
[![{{ crate_name }}](https://img.shields.io/crates/v/{{ crate_name }}?label={{ crate_badge_label }}&logo=rust)]({{ crate_registry_url }})
<!-- bijux-atlas-badges:family-crate-badge:end -->

Runtime Docs Badge

<!-- bijux-atlas-badges:family-rust-docs-badge:start -->
[![{{ crate_name }} rust-docs](https://img.shields.io/badge/rust--docs-{{ crate_badge_label }}-DEA584?logo=rust&logoColor=white)]({{ crate_docs_url }})
<!-- bijux-atlas-badges:family-rust-docs-badge:end -->

GHCR Release Bundle Badge

<!-- bijux-atlas-badges:family-ghcr-badge:start -->
[![ghcr-{{ crate_badge_label }}](https://img.shields.io/badge/ghcr-{{ crate_badge_label }}-181717?logo=github)]({{ crate_ghcr_url }})
<!-- bijux-atlas-badges:family-ghcr-badge:end -->

Handbook Docs Badge

<!-- bijux-atlas-badges:family-docs-badge:start -->
[![{{ docs_badge_alt }}](https://img.shields.io/badge/docs-{{ docs_badge_label }}-2563EB?logo=materialformkdocs&logoColor=white)]({{ docs_url }})
<!-- bijux-atlas-badges:family-docs-badge:end -->