Skip to content

docs: add NuGet version badges to root and package READMEs#290

Merged
Vulthil merged 1 commit into
mainfrom
docs/nuget-badges
Jul 4, 2026
Merged

docs: add NuGet version badges to root and package READMEs#290
Vulthil merged 1 commit into
mainfrom
docs/nuget-badges

Conversation

@Vulthil

@Vulthil Vulthil commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a NuGet column to all five package tables in the root README, with a live shields.io version badge per package linking to its nuget.org page.
  • Adds the same version badge directly under the title of every package README in src/ (all 24). These READMEs are packed into the packages (PackageReadmeFile), and img.shields.io is on nuget.org's allowed image-domain list, so the badges will also render on each nuget.org package page starting with the next published release (existing package READMEs are immutable).

Badges are served live from img.shields.io/nuget/v/<PackageId>, so they always show the latest stable version with no CI or release-pipeline changes.

The docs-site articles (docs/articles/*.md) intentionally get no badges: the docs site is versioned, and a live latest-version badge inside an older docs snapshot would contradict the version being viewed.

Verification

  • git diff is markdown-only: +2 lines per package README (badge + blank line), table rewrite in the root README; CRLF line endings preserved.
  • Queried the shields.io endpoint for the published package IDs, including the mixed-case Vulthil.xUnit — both resolve to nuget v1.0.1.

Backport to v1.0: no — cosmetic docs change; servicing releases don't need it, and the badge always shows the latest stable version anyway, which would look out of place on an older package's page.

@claude

claude Bot commented Jul 4, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@Vulthil
Vulthil merged commit 7911e5c into main Jul 4, 2026
6 checks passed
@Vulthil
Vulthil deleted the docs/nuget-badges branch July 4, 2026 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant