Repository navigation
Turn the main README into a landing page with per-version READMEs - #245
Merged
Merged
Conversation
S3 text moves out of the main README. S2 and S2.5 text comes from the main README before each was replaced. Old CLI names (agent_s2, agent_s for S2.5) now point to python -m gui_agents.<ver>.cli_app, since agent_s runs S3. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Keeps the header, a short quick start (Simular API, or Agent S3 via gui-agents), a version table linking to each version's README, recent updates and citations. Older updates go in a collapsed block. The OSWorld setup docs now link to their version's README for setup. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Landing-page links are absolute so they work on PyPI. Adds the API docs link. Fixes the S2 CLI example (trailing backslash, wrong default model). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
S1 README links to models.md and OSWorld.md were broken. S2 and S2.5 READMEs now say to install tesseract, which their grounding code imports. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Also removes an API docs link that a sed added to an update entry by mistake. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The S3 README already has the same steps, so the landing page keeps one line that points there. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Richard-Simular
requested review from
011235813,
eric-simu,
eric-xw and
simularlyon
October 21, 2026 19:18
Richard-Simular
force-pushed
the
readme-landing-page
branch
from
October 21, 2026 19:22
bb4006a to
ad5c122
Compare
eric-xw
approved these changes
Oct 21, 2026
eric-xw
left a comment
eric-xw
left a comment
Collaborator
There was a problem hiding this comment.
Review
The root README is now a clean landing page that routes to per-version READMEs — exactly what was needed. CI passes on both 3.10 and 3.11.
Verified
- Root README trimmed from ~430 → ~115 lines, keeping only the essentials (mission, SOTA highlights, quick start, version matrix)
- Per-version READMEs created/preserved for S1, S2, S2.5, S3, and S4 — all links resolve (HTTP 200)
- OSWorld setup guides updated to point to the new sub-READMEs instead of the root
Minor suggestions (non-blocking)
- Consider using relative links (e.g.
./gui_agents/s3/README.md) instead of absolute GitHub URLs in the version table — relative links work better for branch previews and local browsing. Not a blocker.
LGTM ✅
…p.py Relative links work in branch previews and local browsing (Eric's review). setup.py rewrites ./ links to GitHub URLs, since PyPI cannot resolve them. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Done in 47c9394: the README now uses relative links ( One catch: |
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.
Makes the main README a short landing page that links to a separate README for each Agent S version.
gui_agents/s3/README.md: the S3 install, CLI, SDK and OSWorld text, moved from the main README.gui_agents/s2/README.mdandgui_agents/s2_5/README.md: rebuilt from the main README as it was before each was replaced. CLI examples now usepython -m gui_agents.<ver>.cli_app, becauseagent_sruns S3 andagent_s2no longer exists.agent_s4/README.md: adds the S4 overview and results.models.md/OSWorld.mdlinks in the S1 README, the missingbrew install tesseractstep for S2 and S2.5, and the S2 CLI example (trailing\, wrong default model).osworld_setup/*/OSWorld.mdnow link to their version's README.Review tip:
git diff main --color-movedshows that most of the diff is moved text.🤖 Generated with Claude Code