Skip to content

docs: link the README's logo by absolute URL so it renders on PyPI - #16

Merged
earakely-scale merged 1 commit into
mainfrom
docs/readme-logo-absolute-urls
Sep 30, 2026
Merged

earakely-scale merged 1 commit into
mainfrom
docs/readme-logo-absolute-urls

Conversation

@earakely-scale

@earakely-scale earakely-scale commented Sep 30, 2026 •

Copy link
Copy Markdown
Collaborator

pyproject.toml publishes README.md as 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 to https://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 its src was the relative path; now it's the absolute URL.

Checked:

  • uv build, then twine check on both the wheel and the sdist: PASSED.
  • Both raw URLs return 200 image/png without authentication.

🤖 Generated with Claude Code

RetriggerConfidence Score: 5/5

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.

  • GitHub keeps its theme-based logo choice.
  • PyPI can load the light logo after removing the dark-mode source.

Reviews (1) · Last reviewed commit: "docs: link the README's logo by absolute..."

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
earakely-scale requested review from a team and polakamtejas as code owners September 30, 2026 18:04
@earakely-scale
earakely-scale merged commit b445b9d into main Sep 30, 2026
9 checks passed
@earakely-scale
earakely-scale deleted the docs/readme-logo-absolute-urls branch September 30, 2026 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant