Skip to content

docs: align entry commands and substrate maturity across repo READMEs - #66

Merged
abrichr merged 1 commit into
mainfrom
docs/readme-alignment
Aug 2, 2026
Merged

docs: align entry commands and substrate maturity across repo READMEs#66
abrichr merged 1 commit into
mainfrom
docs/readme-alignment

Conversation

@abrichr

@abrichr abrichr commented Aug 2, 2026

Copy link
Copy Markdown
Member

Aligns this README with the shared positioning used across the OpenAdapt repositories:

  • Canonical first-run path everywhere: pip install 'openadapt[browser]' + openadapt quickstart; engine-direct commands (openadapt-flow tutorial, demo-record) stay documented as variants of the same loop.
  • One shared substrate-maturity table, verbatim in all five repo READMEs, matching the website/docs supported-substrate positioning (Browser Beta/production; native desktop, RDP, Citrix available for customer-controlled execution with qualification).
  • Tutorial fixture named "MockMed (a synthetic practice-management fixture)" on first mention.
  • cmd.exe double-quoted install form shown beside the POSIX single-quoted form.

Wording alignment only; no restructuring.

🤖 Generated with Claude Code

Adopt the canonical first-run path (pip install 'openadapt[browser]' +
openadapt quickstart), keep engine-direct commands as explicit variants of
the same loop, use the shared substrate-maturity table verbatim, name the
tutorial fixture MockMed (a synthetic practice-management fixture) on first
mention, and show the cmd.exe double-quoted install form.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@abrichr
abrichr merged commit 431fd37 into main Aug 2, 2026
12 checks passed
@abrichr
abrichr deleted the docs/readme-alignment branch August 2, 2026 17:02
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