[AAASM-3750] 📝 (docs): Make hub version badges dynamic (drop hardcoded versions)#40
Merged
Merged
Conversation
Replace hardcoded static core (alpha.5) and go-sdk (alpha.4) badges with live shields.io endpoints, and switch the node badge off the stale /alpha npm dist-tag to /beta. core uses github/v/release?include_prereleases&sort=semver (a non-release spec/* tag pollutes tag-sort; core cuts Releases); go uses github/v/tag?sort=semver (no Releases). Update prose (beta; all badges live).
core/go were hardcoded static badges (beta.2, already stale vs beta.4/beta.3 and contradicting the home page). Switch to the same live endpoints and rewrite the rationale prose (all four badges are now live).
The [badges] block claimed the dynamic github/v form "renders as an error" and cited literal beta.2 versions. Rewrite to describe the live endpoints actually used (release for core, tag for go, PyPI/npm-beta for the SDKs).
Contributor
Author
🔍 Code Review — Claude CodeTicket: AAASM-3750 · Scope: make hub version badges dynamic (no hardcoded versions) 1. CI status — ✅ green
2. Scope coverage vs ticket — ✅ complete
All four badge URLs verified rendering the correct live versions via shields.io (core beta.4 / go beta.3 / node beta.5 / python b5). 3. Side-effect analysis — ✅ none
Verdict: ✅ Ready to approve & mergeFull scope delivered, CI green, zero side-effects. Follow-up (out of scope, tracked in AAASM-3750): npm Automated review by Claude Code. |
|
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 changed
The docs hub (https://docs.agent-assembly.com/) rendered hardcoded / stale version badges. This PR makes every version badge live — no version baked into any badge.
badge/core-v0.0.1--alpha.5(home) /…--beta.2(compat)github/v/release/…/agent-assembly?include_prereleases&sort=semverbadge/go--sdk-v0.0.1--alpha.4/…--beta.2github/v/tag/…/go-sdk?sort=semvernpm/v/…/alpha(stale channel)npm/v/…/betaRenders now resolve to the real published versions: core v0.0.1-beta.4, go v0.0.1-beta.3, node 0.0.1-beta.5, python 0.0.1b5 (verified against shields.io live).
Why
The home page badges were frozen at
alpha.5/alpha.4; the compatibility page had drifted to a different hardcoded value (beta.2) — the two pages even disagreed. Hardcoded "bumped at release" badges go stale by design.Endpoint choice (why not one form for both)
github/v/release(nottag): the monorepo carries a non-releasespec/*tag that pollutesgithub/v/tagsemver sorting; core cuts GitHub Releases, so the release endpoint is authoritative.github/v/tag: go-sdk publishes version tags but no GitHub Releases, sogithub/v/releaseis empty there.Also corrected the now-wrong prose on both pages and the stale
compatibility.toml[badges]notes (which had claimed the dynamic form "renders as an error").Scan scope
Scanned all five doc systems (core mdBook, this hub, python-sdk mkdocs, node-sdk docusaurus, go-sdk hugo) for hardcoded-version badges. Only this hub was affected — every per-repo README already uses dynamic badges.
Verify
python3 docs/scripts/generate_compatibility.py --check→ no drift (badge strip is hand-written, outside the generated markers).img.shields.io/badge/…<version>or/alphadist-tag remains underdocs/.Follow-ups (out of scope, noted in the ticket)
latestdist-tag for@agent-assembly/sdkis stale atalpha.3(release-process item).Closes AAASM-3750
🤖 Generated with Claude Code