Add PyPI and spec version shields to homepage#115
Merged
Conversation
The docs homepage now carries dynamic shields between the tagline and the button row: the PyPI package version (sourced from img.shields.io/pypi/v/openarmature) and the pinned spec version (sourced from img.shields.io/badge/dynamic/toml against the pyproject.toml on main). Both auto-update on every publish or spec bump with zero maintenance. Mirrors the same shield URLs the README has used for several releases, so the rendering quirks are already known. Position is between tagline and Get started button so a reader sees the current version before the call to action.
There was a problem hiding this comment.
Pull request overview
Adds version visibility to the docs homepage by surfacing the current published package version and the pinned spec version as dynamic shields.
Changes:
- Add PyPI version and spec-version shields to
docs/index.mdbetween the tagline and CTA buttons. - Document the homepage shield addition in
CHANGELOG.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/index.md | Adds PyPI + spec-version shield badges to the homepage hero area. |
| CHANGELOG.md | Notes the homepage badges under Unreleased → Added. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The two homepage shield links didn't carry the ``target='_blank' rel='noopener'`` attr_list that every other external link on docs/index.md sets (View on GitHub button, Read the spec link). Clicking a badge would have navigated the visitor out of the docs site instead of opening a new tab. Add the same attr_list to both shields so they follow the page convention.
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
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.
Summary
Last of five docs-polish items. Adds two dynamic shields to
docs/index.mdbetween the tagline and the button row:img.shields.io/pypi/v/openarmature): pulls the published version from PyPI's API.img.shields.io/badge/dynamic/toml): readstool.openarmature.spec_versionfrom thepyproject.tomlonmain.Both auto-update on every publish or spec bump; no maintenance burden. Mirrors the same shield URLs the README has used for several releases, so the rendering quirks are already known.
Position between tagline and "Get started" button so a reader sees the current version before the call to action.
Test plan
mkdocs serve, eyeball the homepage in both light + dark mode0.11.0and spec shield shows0.38.0Out of scope
Wraps up the docs-polish sweep
This is the final PR in the five-item docs-polish sweep that landed alongside #111-#114. Sequence: patterns expansion (#111), vLLM production notes (#112), stale-ref + em-dash sweep (#113), README + homepage pitch refresh (#114), version shields (this PR).