docs(readme): use absolute repo URLs so PyPI links resolve - #75
Merged
Merged
Conversation
The README is the PyPI project description (readme = "README.md"), which PyPI renders in isolation with no repository context. Relative Markdown links are emitted verbatim by PyPI's renderer, so they resolve against the project page URL and 404 for anyone landing from pip: - the "original README" link (README-general.md) — now the only place the usage docs live for this deprecation release - the license badge's link target and the prose LICENSE link Rewrite all three as absolute URLs pinned to the v1.0.84 tag (blob/v1.0.84/...) rather than a branch, so they stay valid if files move or the branch is renamed. Prose, headings, the deprecation warning, and the already-absolute links (docs.hydrolix.io, mailto) are unchanged. Note: these URLs 404 until the v1.0.84 tag is created and pushed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
hdx-heatherblairs
approved these changes
Sep 10, 2026
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
2 participants
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
The README is the PyPI project description (
readme = "README.md"inpyproject.toml). PyPI renders it in isolation with no repository context, and its renderer (readme_renderer) emits relative Markdown links verbatim — it does not rewrite them to the repo. So relative links resolve against the project page URL (e.g.https://pypi.org/project/hdxcli/1.0.84/LICENSE) and 404 for anyone landing frompip.This rewrites the three relative links to absolute URLs, pinned to the
v1.0.84tag:README-general.mdhttps://github.com/hydrolix/hdxcli/blob/v1.0.84/README-general.mdLICENSEhttps://github.com/hydrolix/hdxcli/blob/v1.0.84/LICENSELICENSEhttps://github.com/hydrolix/hdxcli/blob/v1.0.84/LICENSEThe
README-general.mdlink matters most here: for this deprecation release it's the only place the usage docs live, and it's a plain text link with no badge image masking the break.Why pin to the tag, not a branch
blob/v1.0.84/...keeps the links valid if files move or the branch is later renamed. These URLs 404 until thev1.0.84tag is created and pushed — expected; create the tag at release time.Scope / non-changes
> [!WARNING]/> [!NOTE]GitHub alert syntax is intact (degrades to blockquotes on PyPI, which is fine).docs.hydrolix.iorelease-notes link, thesupport@hydrolix.iomailto, and the shields.io badge image (it renders fine — only its link target was broken).README-general.mdnot touched (it isn't packaged as the PyPI description).Validation
poetry build+twine check dist/*→ both PASS (twine doesn't resolve link targets, so it passes regardless of the tag existing).run_tests.yml), so nothing fetches these URLs to block on the expected 404s.readme_rendereroutputshref="LICENSE"verbatim → resolves to a 404 on the PyPI page.🤖 Generated with Claude Code