docs: lead README + docs home with a badge row (PyPI, Docker, Ruff, cosign) + feature subtitle - #108
Merged
Merged
Conversation
Move the badges directly under the H1 (above the tagline) so the status/install signals are the first thing a visitor sees, and add three high-signal badges: - PyPI version — the package is published; shows it is installable + current. - Docker / GHCR — bubo ships a multi-arch image. - Ruff — code-quality signal; bubo lints with ruff. Also re-point the uv badge at the uv project. No changes below the header.
mountainowl
changed the title
This was referenced Jun 17, 2026
mountainowl
added a commit
that referenced
this pull request
Jun 17, 2026
…cs mirror The second commit of #108 (cosign badge, feature subtitle, docs/index.md mirror) never reached main — only the first commit (PyPI/Docker/Ruff row) merged. Reconcile main with what #108 intended, and add the new SLSA L3 badge: - README badge row: add `release: cosign signed` (Sigstore keyless signing, in place for many releases) and `SLSA 3` (Build L3 provenance, wired in the release workflow) in the security cluster after OpenSSF Scorecard. - README: add the feature subtitle under the tagline. - docs/index.md: mirror the full badge row (minus the self-referential Docs badge) + the subtitle, so the docs home matches the README.
mountainowl
added a commit
that referenced
this pull request
Jun 17, 2026
…cs mirror (#114) The second commit of #108 (cosign badge, feature subtitle, docs/index.md mirror) never reached main — only the first commit (PyPI/Docker/Ruff row) merged. Reconcile main with what #108 intended, and add the new SLSA L3 badge: - README badge row: add `release: cosign signed` (Sigstore keyless signing, in place for many releases) and `SLSA 3` (Build L3 provenance, wired in the release workflow) in the security cluster after OpenSSF Scorecard. - README: add the feature subtitle under the tagline. - docs/index.md: mirror the full badge row (minus the self-referential Docs badge) + the subtitle, so the docs home matches the README. Co-authored-by: mountainowl <mountainowl@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Puts the badge row directly under the H1 (above the tagline) on both the README and the docs site home, so status/install/trust signals are the first thing a visitor sees — and adds high-signal, all-true badges plus a scannable feature subtitle.
Badge row (order = install → health → security → quality → tooling → license):
PyPI · Python 3.14+ · Docker (GHCR) · CI · OpenSSF Scorecard · cosign-signed · Ruff · uv · LicenseAdded:
release.yml), as are the SBOM and the Docker image's BuildKit provenance. Deliberately not a "SLSA Level 3" claim — the image provenance isbuild-push-action(~SLSA Build L2), not the L3 a dedicatedslsa-github-generatorwould assert.Feature subtitle under the tagline (both files):
Docs home (
docs/index.md) mirrors the row minus the self-referential Docs badge.mkdocs build --strictpasses.Notes
ghcr.io/mountainowl/bubois public (it must be, ordocker pullalready fails for everyone), else the link 404s for visitors.test_project_layoutfailure that test: realign project-layout asset guard with current README #106 fixes (main red since fix(docs): owl intro, feature tables, MCP page; drop stale-branded images #100); this PR is docs-only. Merge test: realign project-layout asset guard with current README #106 (or rebase this on it) to green CI.