docs: use absolute image URLs in README for PyPI rendering#11
Closed
mnriem wants to merge 1 commit into
Closed
Conversation
Relative image paths do not render on the PyPI project page. Convert the logo and demo GIF references to absolute raw.githubusercontent.com URLs so they display correctly on https://pypi.org/project/specify-cli/ while continuing to render on GitHub. Fixes the rendering gap noted in github#2908. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
The README renders fine on GitHub but the logo and demo GIFs do not appear on the PyPI project page (https://pypi.org/project/specify-cli/) because they use relative paths. PyPI does not resolve relative image paths.
This converts the three relative image references to absolute
raw.githubusercontent.comURLs so they display correctly on PyPI while continuing to render on GitHub:media/logo_large.webp(header logo)media/specify_cli.gifmedia/bootstrap-claude-code.gifThe shields.io badges were already absolute and are unchanged.
Context
Follow-up to github#2915 (which added
readme = "README.md"topyproject.toml). As noted in github#2908, the README now publishes to PyPI but the images still don't render. This addresses that rendering gap.Relates to github#2908.