Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
earakely-scale merged 2 commits into from
Sep 30, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f78d51e
docs: title the README with a logo banner that reads in every theme
earakely-scale Sep 30, 2026
e8a32ae
docs: name AgentEnv Framework, not the protocol, as what builds and d…
earakely-scale Sep 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>

@greptile-apps greptile-apps Bot Sep 30, 2026

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

@earakely-scale earakely-scale Sep 30, 2026

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.

@greptile-apps greptile-apps Bot Sep 30, 2026

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.


AgentEnv Framework is a Python SDK and CLI for building, deploying and running agentic environments and the tasks that grade agents inside them. Environments are containerized servers that speak the open `agentenv-framework-protocol`; it builds them into versioned images, deploys them behind a gateway, points an agent at them, and scores what the agent did.
AgentEnv Framework is a Python SDK and CLI for building, deploying and running agentic environments and the tasks that grade agents inside them. Environments are containerized servers that speak the open `agentenv-framework-protocol`; AgentEnv Framework builds them into versioned images, deploys them behind a gateway, points an agent at them, and scores what the agent did.

**Documentation: [www.agentenvframework.com/docs](https://www.agentenvframework.com/docs)** covers environments, artifacts, agents, tasks, the registry and plugins.

Expand Down
Binary file added assets/brand/readme-banner.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading