Skip to content

docs: play the explainer video inline in the README - #230

Merged
tupe12334 merged 1 commit into
mainfrom
docs/readme-inline-video
Oct 7, 2026
Merged

tupe12334 merged 1 commit into
mainfrom
docs/readme-inline-video

Conversation

@tupe12334

@tupe12334 tupe12334 commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

Summary

#229 linked a poster image to an MP4 committed in docs/media/. GitHub renders a relative MP4 link as a plain link, so the README had no inline player.

GitHub shows a <video controls> player only for https://github.com/user-attachments/assets/<uuid> URLs. This PR:

  • uploads the video as a user attachment (POST uploads.github.com/user-attachments/assets)
  • puts the bare attachment URL on its own line in the README
  • removes docs/media/steplock-explained.mp4 and the poster PNG, which nothing else uses

Verification

  • gh api markdown with context=polyhook/steplock renders the attachment URL as <video src=... controls>.
  • Logged-out headless Chrome on the branch README page: the inline player loads and plays (readyState 4, 1920x1080, 92.5 s, currentTime advanced to 2.38 s).
  • Local cargo test: 179 passed. All 13 CI checks pass.

Kev gate (local Kev)

  • Scope: keep 0.82. Remove the unused media files: 0.61 (keep: 0.39).
  • Round 1: merge 0.85. Concern "no browser playback check": 0.48.
  • Fix: played the video in logged-out Chrome.
  • Round 2: merge 0.96. Browser concern: 0.35.

🤖 Generated with Claude Code

GitHub shows an inline video player only for user-attachments URLs.
A relative link to an MP4 in the repo renders as a plain link. Upload
the video as a user attachment, put its bare URL in the README, and
remove the MP4 and poster that were committed in docs/media.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tupe12334
tupe12334 merged commit b9e2cc1 into main Oct 7, 2026
13 checks passed
@tupe12334
tupe12334 deleted the docs/readme-inline-video branch October 7, 2026 09:08
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