Skip to content

docs(readme): add the CLI walkthrough demo GIF - #207

Open
Xuepoo wants to merge 1 commit into
mainfrom
docs/readme-demo-gif
Open

Xuepoo wants to merge 1 commit into
mainfrom
docs/readme-demo-gif

Conversation

@Xuepoo

@Xuepoo Xuepoo commented Sep 28, 2026

Copy link
Copy Markdown
Owner

Adds an animated CLI walkthrough to the hero position of both README
variants (right below the language switcher):

init → agent register → task create → task claim → session start
→ progress note → checkpoint → resume

It shows the shortest end-to-end lifecycle on a real project, including the
resume output that proves the persisted context comes back.

  • Served from the project CDN (cdn.xuepoo.xyz), so no binary asset is added
    to the repository.
  • Uses <p align="center"><img ... width="100%"></p> for a full-width hero.
  • README.zh-CN.md carries the same figure with a Chinese alt text so the two
    README variants stay in sync.

Verification:

  • just markdownlint → 0 issues
  • cargo check and cargo test --workspace --lib pass (pre-push hook)
  • CDN asset returns 200, image/gif, 630154 bytes

Add the animated walkthrough to the top of both README variants, right
below the language switcher: init, agent register, task create, claim,
session start, progress note, checkpoint, resume.

The GIF is served from the project CDN, so the repository does not carry
a binary asset.
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