Repository navigation
Make README links absolute + add release badge for v0.2.1 - #36
Merged
Merged
Conversation
The packed README ships inside the nupkg, so nuget.org renders it from the package — repo-relative paths to docs/screenshots/, LICENSE, CLAUDE.md, and the docs/integrator/ guides 404 in that context. Promotes every in-repo reference to an absolute https URL (images via raw.githubusercontent.com, docs/code via github.com/.../blob/main). Also adds an img.shields.io GitHub-release badge to the header (between Build and License) now that the repo is public. Picked the GitHub release badge rather than nuget/v because distribution is via the Optimizely NuGet feed, not nuget.org. RELEASE-NOTES.md gets a v0.2.1 section so the tag-triggered publish workflow has a body to carve out.
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.
What changed
LICENSE,CLAUDE.md, anddocs/links are now absolutehttps://github.com/.../URLs (images viaraw.githubusercontent.com). The packed README ships inside the nupkg, so repo-relative paths 404 when rendered from the nuget.org package page — v0.2.0's screenshots were broken there.img.shields.io/github/v/releasebadge to the README header (between Build and License), linking to/releases/latest. Chose the GitHub release badge overnuget/vbecause distribution is via the Optimizely NuGet feed, not nuget.org.RELEASE-NOTES.mdgains a## v0.2.1section so the tag-triggered publish workflow has a body to carve out.Testing
v0.2.1and confirmpublish.ymlsucceeds (finds the matching release-notes section, packs, attaches.nupkgto the GitHub release).Developer notes