Skip to content

docs: title the README with a logo banner that reads in every theme - #31

Merged
earakely-scale merged 2 commits into
mainfrom
docs/readme-logo-banner
Sep 30, 2026
Merged

earakely-scale merged 2 commits into
mainfrom
docs/readme-logo-banner

Conversation

@earakely-scale

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

Copy link
Copy Markdown
Collaborator

This puts the logo back at the top of the README, which is also the PyPI project page. It's a banner that reads in GitHub's light and dark themes alike, and on PyPI.

Why a banner

The README used to open with a <picture> that switched between a black-text and a white-text lockup on prefers-color-scheme. That media query follows the operating system, not GitHub's theme, so with GitHub set to dark and the OS set to light, visitors saw a black wordmark on a dark page. #30 replaced it with a text title.

This PR keeps the logo in a form that doesn't depend on the theme:

  • The banner: assets/brand/readme-banner.png is cut from the social preview. It's the white-text lockup on its own dark card with rounded corners, so it looks the same on a light or a dark page.
  • The title: the banner is the README's <h1>, with "AgentEnv Framework" as its alt text, so the name isn't repeated under the logo.
  • The image URL: src is an absolute main URL, because PyPI can't resolve relative image paths. GitHub shows the banner once this merges.

Also

The opening paragraph's second sentence said "…speak the open agentenv-framework-protocol; it builds them…", which read as though the protocol builds and deploys environments. It now names AgentEnv Framework, as Greptile suggested on #30.

Verification

  • I previewed the banner at README width on GitHub's light (#ffffff) and dark (#0d1117) page backgrounds, and it reads on both.
  • twine check --strict passes on the built wheel and sdist, so PyPI's renderer accepts the markup.
  • tst/unit/test_check_plugin_api.py, which parses the README, passes.

bump-version is set so the banner reaches PyPI.

🤖 Generated with Claude Code

RetriggerConfidence Score: 4/5

The PR appears safe to merge, though older PyPI pages could lose or change their banner later.

Fix All in CursorFindings

  1. P2 Older banners can change ▶
Fix with agent prompt
### Issue 1
README.md:1
The banner URL points to `main`, even when the README is published for a release tag. If someone later replaces or removes that file on `main`, visitors to an older PyPI release will see the wrong banner or a broken image. Point the image at a fixed revision so each release keeps its banner.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Summary

The README now opens with a logo banner, which also appears on the PyPI project page. Its opening description names AgentEnv Framework as the builder and deployer of environments.

  • The banner serves as the README title and uses an absolute image URL.
  • The introduction names AgentEnv Framework explicitly.

Reviews (1) · Last reviewed commit: "docs: name AgentEnv Framework, not the p..."

A banner cut from the social preview carries its own dark background and rounded corners, so the
logo reads the same in GitHub's light and dark themes and on PyPI, whatever the operating
system's color scheme. It is the README's h1, with the product name as its alt text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@earakely-scale
earakely-scale requested a review from a team as a code owner September 30, 2026 22:24
@earakely-scale earakely-scale added documentation Improvements or additions to documentation bump-version labels Sep 30, 2026
…eploys environments

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread README.md
@@ -1,6 +1,6 @@
# AgentEnv Framework
<h1><img alt="AgentEnv Framework" src="https://raw.githubusercontent.com/scaleapi/agentenv-framework/main/assets/brand/readme-banner.png"></h1>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Older banners can change

The banner URL points to main, even when the README is published for a release tag. If someone later replaces or removes that file on main, visitors to an older PyPI release will see the wrong banner or a broken image. Point the image at a fixed revision so each release keeps its banner.

Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 1

Comment:
**Older banners can change**

The banner URL points to `main`, even when the README is published for a release tag. If someone later replaces or removes that file on `main`, visitors to an older PyPI release will see the wrong banner or a broken image. Point the image at a fixed revision so each release keeps its banner.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Fix in Cursor Fix in Claude Code Fix in Codex

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keeping main on purpose. The release tag doesn't exist when the README is written, and this PR's commit SHA gets replaced when it's squash-merged, so neither gives a stable URL at authoring time. The previous lockup used main URLs too. The banner is a brand asset under assets/brand/, and anyone who renames it should keep the old path.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That context makes sense. Given the banner is a stable, backward-compatible brand asset, the release tag is unavailable when the README is authored, and squash-merging invalidates the pre-merge commit SHA, keeping the main URL is the practical choice. I’m withdrawing this finding; no change is needed.

@earakely-scale
earakely-scale merged commit 93ea165 into main Sep 30, 2026
14 checks passed
@earakely-scale
earakely-scale deleted the docs/readme-logo-banner branch September 30, 2026 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bump-version documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant