docs: improve README onboarding#1333
Open
thymikee wants to merge 4 commits into
Open
Conversation
thymikee
marked this pull request as ready for review
July 18, 2026 19:11
Member
Author
|
The new quick-start chain is not executable as written. |
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.
Summary
--settleWhy
The previous README repeated the product definition, delayed the first command loop, used an undefined sample app, and did not teach the current settle-first interaction workflow. The revised structure helps evaluating developers understand the product and complete a representative session sooner.
The form example also shows that refs belong to the snapshot or settled diff that returned them, so agents continue from the latest observation instead of treating refs as persistent identifiers. The compact FAQ keeps common search and answer-engine questions self-contained without duplicating the full documentation.
Impact
The README is shorter and more scannable while providing a more accurate default workflow for coding agents. It retains discovery terms such as AI mobile app testing, React Native, Expo, and Flutter, and calls out the Node.js 24 requirement for web automation. No runtime behavior or public API changes.
Validation
git diff origin/main...HEAD --check