Skip to content

docs: README first screen gets a one-line try-it command - #37

Merged
MaxonT merged 1 commit into
mainfrom
docs-readme-try-it
Nov 16, 2026
Merged

MaxonT merged 1 commit into
mainfrom
docs-readme-try-it

Conversation

@MaxonT

@MaxonT MaxonT commented Nov 16, 2026

Copy link
Copy Markdown
Owner

Adds a short Try it line with uvx --from aisync-cli aisync demo after the NOTE block in all nine READMEs (code block identical in every language, as tests/test_readme_languages.py requires).

Checked in a temp HOME with aisync-cli 0.2.11: the demo exits 0, builds a synthetic hub (67 events, chain intact) in its own temp folder, and does not touch the user's hub. test_readme_languages passes locally. Three other tests (two in test_gate.py, test_wheel) fail on unmodified main in my sandbox as well; CI is the real check.

This PR was written by an AI agent (Claude Code) for the maintainer.

The install section sits below the integrations table, so a visitor sees no command on the
first screen. Add a short "Try it" line with `uvx --from aisync-cli aisync demo` after the
NOTE block, in all nine READMEs (the code block is identical in every language, as
tests/test_readme_languages.py requires).

Checked in a temp HOME with aisync-cli 0.2.11: `uvx --from aisync-cli==0.2.11 aisync demo`
exits 0, prints a synthetic hub (67 events, chain intact) and creates its own folder in the
temp directory; nothing appears under the user's home except uv's own cache.
tests/test_readme_languages.py passes. Three other tests (two in test_gate.py, test_wheel)
also fail on unmodified main in this sandbox, so they are not caused by this change.

Agent: claude-code
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-16T15:56:32.062675Z 7cf99cf PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@MaxonT
MaxonT merged commit 5896fb2 into main Nov 16, 2026
6 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