docs: Update README image to absolute URL, fix PyPI rendering #561
Conversation
This file contains 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
product-auto-label
bot
added
size: xs
arbrown
approved these changes
Jun 1, 2022
arbrown
changed the title
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.
When viewing the v3.1.1 README on PyPI, the new "Guide Me" button is a broken image link.
This is a known issue where PyPI needs absolute image links (ref pypi/warehouse#5582 (comment)).
By using the GitHub README's absolute URL of the image (from the
raw.githubusercontent.comdomain), the absolute URL can be referenced and rendered on both PyPI and GitHub README's.Since confirming this fix requires publishing to PyPI, I've published an example package to show the before/after: