Repository navigation
docs: link the README's logo by absolute URL so it renders on PyPI - #16
Merged
Merged
Conversation
pyproject.toml publishes README.md as the PyPI description, and PyPI can't resolve a path relative to the repository, so assets/brand/lockup-light.png rendered as a broken image there. Both lockups now link to raw.githubusercontent.com on main, which serves them now that the repository is public. GitHub shows the same image as before. PyPI's renderer drops the dark-mode <source> and keeps the light <img>. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
earakely-scale
requested review from
a team and
polakamtejas
as code owners
September 30, 2026 18:04
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.
pyproject.tomlpublishesREADME.mdas the PyPI description (readme = "README.md"). PyPI can't resolve paths relative to the repository, so the logo from #6 (assets/brand/lockup-light.png) would render as a broken image on the package page. Both lockups now link tohttps://raw.githubusercontent.com/scaleapi/agentenv-framework/main/assets/brand/…, which serves them now that the repo is public.On GitHub: nothing changes. The
<picture>still shows the light or dark lockup to match the reader's theme.On PyPI: checked with PyPI's own renderer,
readme_renderer[md]46.0. It keeps<picture>and<img>but strips the dark-mode<source>, so PyPI always shows the light lockup. Before this change itssrcwas the relative path; now it's the absolute URL.Checked:
uv build, thentwine checkon both the wheel and the sdist:PASSED.200 image/pngwithout authentication.🤖 Generated with Claude Code
The PR appears safe to merge.
Summary
The README now loads its light and dark logos from public image URLs, so they render in package descriptions too.
Reviews (1) · Last reviewed commit: "docs: link the README's logo by absolute..."