fix(docs): use an absolute URL for the README screenshot so PyPI renders it - #116
Merged
Conversation
# Conflicts: # CHANGELOG.md # docs/about/changelog.md
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.
The oscilloscope screenshot at the top of the README doesn't render on the PyPI project page.
Cause
The
<img>used a repository-relative path:GitHub resolves that against the repo. PyPI renders the README as a standalone document with no repo context, so a relative
srchas nothing to resolve against and the image silently fails. Everything else at the top of the README survives because the badges are already absolute shields.io URLs — which is why only the screenshot was affected.The file itself is present and git-tracked, so this was never broken on GitHub.
Fix
An absolute raw URL, verified to resolve before committing (
HTTP 200,image/png, 21,732 bytes):A comment above the tag records why it must stay absolute, so it doesn't get "tidied" back into a relative path.
Two things worth knowing
PyPI project pages are immutable per release. This does not repair the 5.5.0 page — the screenshot appears from the next release onward.
13 relative links in the README have the same problem (
CHANGELOG.md,CONTRIBUTING.md,SECURITY.md,LICENSE,examples/,docs/gateway/security.md, and others). They 404 on PyPI for the identical reason. They're deliberately left alone here: making them absolute would fix PyPI but means anyone reading the README on a fork or PR branch gets links pointing back at upstreammainrather than their own copy. Worth deciding separately rather than bundling into an image fix.Verification
<img>tags remain in the README.docs/about/changelog.mdre-synced toCHANGELOG.mdand confirmed byte-identical — the two are hand-maintained mirrors and nothing in the suite enforces that.