Skip to content

docs(readme): swap static hero for animated order-flow GIF (B7)#84

Merged
naorsabag merged 1 commit into
masterfrom
readme-hero-gif
May 7, 2026
Merged

docs(readme): swap static hero for animated order-flow GIF (B7)#84
naorsabag merged 1 commit into
masterfrom
readme-hero-gif

Conversation

@naorsabag
Copy link
Copy Markdown
Owner

@naorsabag naorsabag commented May 7, 2026

Summary

  • Replaces `docs/image.png` (single canvas frame, ~575KB) with `docs/order-flow.gif` (animated capture of the live order-flow, 4.0MB)
  • The static PNG didn't communicate that OpenHop animates — visitors had to read the description to learn that. The GIF makes the value prop obvious in the first 2-3 seconds
  • Closes audit item B7 (hero GIF)

Why this GIF

Captured directly from the running web UI showing the example `order-flow` running end-to-end with the inspect panel narrating each step (POST /orders → auth → rate-limit → order-service → DB/cache → Stripe → events). Demonstrates:

  • Multi-node parallel paths
  • The inspect panel showing per-step field shape
  • The pixel-art rabbit actor consistent with the rest of the brand

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the README’s centered hero image to an animated order-flow visualization and improved the image alt text to clearly describe the end-to-end ordering animation for better accessibility and clarity.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 285ffdb6-8252-41c9-a678-ad3070f00f75

📥 Commits

Reviewing files that changed from the base of the PR and between 2964de5 and 15f100b.

⛔ Files ignored due to path filters (2)
  • docs/image.png is excluded by !**/*.png
  • docs/order-flow.gif is excluded by !**/*.gif
📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

Walkthrough

The README hero image asset is replaced with an animated order-flow GIF, updating the image source from docs/image.png to docs/order-flow.gif and adjusting the corresponding alt text.

Changes

Documentation Asset Update

Layer / File(s) Summary
Hero Image Asset
README.md
Centered hero media element source updated from docs/image.png to docs/order-flow.gif with alt text adjusted for the animation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: replacing a static PNG image with an animated GIF in the README. It is concise, actionable, and directly reflects the primary change in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-hero-gif

Comment @coderabbitai help to get the list of available commands and usage tips.

Replaces docs/image.png placeholder with docs/order-flow.gif —
captured directly from the live web UI showing the example
order-flow animating end-to-end with the inspect panel
narrating each step. Closes audit item B7 (hero GIF).

The static PNG was a single canvas frame and didn't communicate
that OpenHop animates; the GIF makes the value prop obvious in
the first 2-3 seconds of viewing the README.
@naorsabag naorsabag merged commit cfe9841 into master May 7, 2026
7 checks passed
@naorsabag naorsabag deleted the readme-hero-gif branch May 8, 2026 06:30
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