Skip to content

docs: autoplaying overview animation at the top of the README - #52

Merged
gspark-etri merged 1 commit into
masterfrom
docs/51-readme-overview-animation
Oct 21, 2026
Merged

gspark-etri merged 1 commit into
masterfrom
docs/51-readme-overview-animation

Conversation

@gspark-etri

Copy link
Copy Markdown
Collaborator

Background

The README opened with a static hero. A 73 s overview animation of the AI-RM layers (L1–L5 and rm-core contracts) now exists for the conference booth. GitHub strips <video autoplay> and does not play repository MP4 files, so an animated image is the only way to have it play on page load.

Changes

  • docs/assets/ai-rm-overview.webp: the full animation as a silent looping animated WebP (960×540, 12 fps, 73 s, 4.9 MB).
  • README.md, README.ko.md: the animation replaces hero.svg in the opening block (same link target, new alt text). hero.svg is kept.
  • docs/assets/README.md: provenance (Remotion, 2026-10-21), the public README each on-screen figure comes from, and a note that the lmd-top screen uses illustrative pod names and values.

Verification

  • python3 tools/check_docs.py → Checked 56 Markdown pages and 18 SVGs: PASS
  • python3 tools/check_sensitive.py . → clean
  • git diff --cached --check → no issues
  • WebP decoded locally with Pillow: 876 frames, loop=0 (infinite). Spot-checked frames for text legibility at 960 px.
  • On-screen figures checked against public READMEs: npu-offload (2.3 → 34.9 tok/s), hetero-npu-p2p (≈3 ms median DMA; RNGD solo 66.3 → PD 98.3 tok/s at output 128), onggi (99.3 % shared bytes), npu-train (NSMC 84.6 % vs 84.2 %, 4.32 vs 3.08 tok/J). No unreleased KPI values; duet is described only as in docs/architecture.md.

Compatibility and limits

  • Adds 4.9 MB to the repository history. The README loads it on first view.
  • Animated WebP plays in current Chrome, Edge, Firefox and Safari. There is no sound.
  • The animation is an illustration, not a recording of a live system. Optimus Prime is labeled as integration in progress.
  • The Remotion source is not in this repository.

Related Issue

Closes #51

🤖 Generated with Claude Code

GitHub README pages do not autoplay video, so the 73 s overview animation
is added as a silent looping animated WebP (960x540, 12 fps, 4.9 MB) and
replaces hero.svg at the top of README.md and README.ko.md. hero.svg stays
in the repository. Provenance and the public source of every on-screen
figure are recorded in docs/assets/README.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@gspark-etri
gspark-etri merged commit a77f6f8 into master Oct 21, 2026
6 checks passed
@gspark-etri
gspark-etri deleted the docs/51-readme-overview-animation branch October 21, 2026 10:55
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.

docs: autoplaying overview animation at the top of the README

1 participant