Skip to content

docs: add animated oaeval init --interactive demo GIF to README - #287

Merged
himanshu231204 merged 2 commits into
mainfrom
claude/bug-investigation-fixes-rbq6lk
Aug 16, 2026
Merged

docs: add animated oaeval init --interactive demo GIF to README#287
himanshu231204 merged 2 commits into
mainfrom
claude/bug-investigation-fixes-rbq6lk

Conversation

@himanshu231204

Copy link
Copy Markdown
Member

Description

Replaces the static wizard screenshot in the README's Quick Start section with an animated demo GIF of a real oaeval init --interactive session.

The GIF is built from an actual recorded run (via pexpect, capturing real ANSI output and timing — not a mockup), replayed through a virtual terminal (pyte) and rendered frame-by-frame with PIL into a polished macOS-style terminal window (traffic-light dots, title bar, blinking cursor), then optimized with gifsicle (~800KB, no visible quality loss).

The recorded session walks through: dataset path → LLM provider (Anthropic) → model → retriever (Chroma) → metric preset (Standard) → output format, ending with the generated config.yaml and the "Next steps" output.

Changes

  • Add docs/assets/oaeval-init-demo.gif
  • Update README Quick Start section to embed the GIF (replacing static/openagent-eval.png) and add a short description of what the wizard does
  • Remove static/openagent-eval.png (now unreferenced) and the now-empty static/ directory

Type of Change

  • Documentation update

How Has This Been Tested?

  • Verified the GIF renders correctly (checked first/middle/last frames) and displays the real CLI output, including generated config content
  • Confirmed no remaining references to the removed static/openagent-eval.png path in docs or config

Checklist

  • My change follows the project's conventions
  • I have performed a self-review of my own change
  • Documentation renders correctly

Generated by Claude Code

… GIF

Records a real `oaeval init --interactive` session (dataset prompt,
provider/model/retriever selection, metric preset, output format) and
replays it through a virtual terminal into a polished, macOS-style
terminal window GIF, embedded in the Quick Start section of the README.
Copilot AI lite review requested due to automatic review settings August 16, 2026 13:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@himanshu231204
himanshu231204 merged commit ee37945 into main Aug 16, 2026
10 checks passed
@github-actions

Copy link
Copy Markdown

🎉 Congratulations @himanshu231204!

Your pull request has been successfully merged into main. 🚀

Thank you for contributing to OpenAgentHQ and helping improve the project.

We truly appreciate your contribution and hope to see you back with more amazing PRs!

Happy Open Sourcing! ❤️

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.

3 participants