Repository navigation
README and home page explain Agentry to newcomers - #47
Merged
Merged
Conversation
The README and the site's home page now start from what Agentry does and define the User-Agent header before anything else. The full method list, Internet Explorer and Safari notes, aliases and matcher recipes, already on the guide and the Bots page, are summarized with links instead of repeated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VLwjZvdTtyBSS7TRsQr9tf
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.
The README and the home page were written for people who already use the browser gem. Someone who has never heard of either had no definition of a user agent, met a 120-line method list before learning what the gem is for, and a home page whose headline was "Same API as browser, faster".
Both now open with what Agentry does and what a
User-Agentheader is, then why to pick it, how to install it and a first example with its results. Reference material the guide and the Bots page already hold is summarized in a sentence with a link instead of being repeated.eager_load!stay in the README, since the site does not cover them.Checks
Every example result in the README and on the home page was run against
lib/(Safari 18.1 on iPhone, GPTBot, Claude-User, Googlebot with a Google IP, Cloudflare headers).script/highlight_docs.rb --checkandscript/render_docs.rb --checkpass. Playwright at 1280 px and 390 px shows no horizontal scroll.