Skip to content

docs: README usability — Quick Start first, tone down promo copy#538

Merged
jackwener merged 20 commits intomainfrom
codex/release-1.5.2
Mar 28, 2026
Merged

docs: README usability — Quick Start first, tone down promo copy#538
jackwener merged 20 commits intomainfrom
codex/release-1.5.2

Conversation

@jackwener
Copy link
Copy Markdown
Owner

Changes

  • Reorder sections: Why opencli → Quick Start → Prerequisites
    Users now see "how to install & run" before "what you need to set up", matching natural reading flow
  • Tone down Electron promo: Replace "CLI All Electron Apps! The Most Powerful Update Has Arrived!" with a plain one-liner
  • Quick Start clarity: Added (requires Extension) hint to browser command so new users know why it might not work immediately
  • Clean up Prerequisites: Remove npm run dev:bun / test:e2e dev commands — those belong in contributor docs, not end-user setup

Remove redundant command table (already in docs/adapters/index.md).
Keep badges, quick-start, and star history only.
- CDPPage.wait(N>=1) now uses waitForDomStableJs instead of fixed sleep,
  matching Page.wait() behavior and saving unnecessary idle time
- waitForSelectorJs switches from 100ms polling to MutationObserver,
  resolving instantly when the target element appears in the DOM
- Update dom-helpers tests to stub MutationObserver for Node eval context
Replace the 70-row site/command table in README with a one-line link.
All other README sections (Highlights, Why opencli, Quick Start,
External CLI Hub, Desktop App Adapters, Download, Plugins, AI Agents,
Troubleshooting) are preserved unchanged.
# Conflicts:
#	README.md
#	extension/manifest.json
#	extension/package-lock.json
#	extension/package.json
#	package-lock.json
#	package.json
… copy

- Reorder sections: Why opencli → Quick Start → Prerequisites
  so users see "how to use" before "what you need"
- Replace "The Most Powerful Update Has Arrived!" marketing copy
  with a plain one-liner description of the Electron feature
- Remove redundant Bun dev/test commands from Prerequisites
  (developer-only content, not relevant to end users)
- Add "(requires Extension)" hint to browser command in Quick Start
@jackwener jackwener merged commit c4e7a94 into main Mar 28, 2026
9 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