Shorten README and lead with agent-assisted setup - #1
Merged
Merged
Conversation
alexanderqchen
marked this pull request as ready for review
September 15, 2026 19:38
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
The README currently mixes basic setup with detailed operational and development instructions. This draft makes the first action a copy-and-paste prompt for a Codex agent, followed by a short overview and a plain-language settings table.
docs/reference.md.Validation
zsh -n bin/codex-update-helperpassed../tests/test.shpassed all 20 test groups.Documentation only. Ready for editorial review as a draft PR; no runtime behavior changes.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.