Skip to content

Shorten README and lead with agent-assisted setup - #1

Merged
alexanderqchen merged 1 commit into
mainfrom
docs/short-readme
Sep 15, 2026
Merged

alexanderqchen merged 1 commit into
mainfrom
docs/short-readme

Conversation

@alexanderqchen

@alexanderqchen alexanderqchen commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

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.

  • Reduces the README from 1,121 to 447 words (60% shorter).
  • Keeps the overnight defaults, active-task behavior, permission requirement, sleep limitation, and English-dialog scope visible.
  • Moves manual installation, CLI examples, migration notes, troubleshooting, logs, uninstall steps, and implementation/development details into docs/reference.md.
  • Adds background Accessibility verification guidance to the reference so agent-assisted setup does not mistake inherited foreground access for a working service permission.

Validation

  • Relative documentation links, logo path, Markdown fences, and whitespace checked.
  • zsh -n bin/codex-update-helper passed.
  • ./tests/test.sh passed all 20 test groups.

Documentation only. Ready for editorial review as a draft PR; no runtime behavior changes.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

@alexanderqchen
alexanderqchen marked this pull request as ready for review September 15, 2026 19:38
@alexanderqchen
alexanderqchen merged commit 99b1e2a into main Sep 15, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant