Skip to content

docs: improve README onboarding and reference - #7

Merged
github-actions[bot] merged 1 commit into
mainfrom
docs/readme-overhaul
Sep 3, 2026
Merged

github-actions[bot] merged 1 commit into
mainfrom
docs/readme-overhaul

Conversation

@mastertyko

Copy link
Copy Markdown
Owner

Summary

  • Lead with a three-step install and readiness path.
  • Separate native Computer Use from the one-owned-tab Chrome surface.
  • Replace long prose lists with scannable tool, command, requirement,
    configuration, and troubleshooting tables.
  • Clarify permissions, fail-closed behavior, trust probing, uncertain outcomes,
    development checks, releases, and project links.

Accuracy checks

  • All 12 Computer Use tools and all 3 Chrome tools match source registration.
  • All 8 /codex-computer commands match the command handler.
  • All 6 documented environment variables match runtime source.
  • Unsupported providers, existing tabs, raw JavaScript, and CDP remain
    explicitly out of scope.
  • Poisoned Chrome runs are not described as guaranteed tab cleanup.

Verification

  • markdownlint: 0 issues with line-length disabled for tables and URLs
  • bun run check: 21 files, 233 tests
  • npm pack --dry-run
  • Gitleaks: no leaks
  • GitHub and badge links: HTTP 200
  • npm page: verified through Chrome

@github-actions
github-actions Bot enabled auto-merge September 3, 2026 17:39
@github-actions
github-actions Bot merged commit f491f4b into main Sep 3, 2026
2 checks passed
@mastertyko
mastertyko deleted the docs/readme-overhaul branch September 3, 2026 17:48
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