Skip to content

docs: add a narrated explainer video to the README - #229

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

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

Conversation

@tupe12334

@tupe12334 tupe12334 commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

Summary

Adds a 92-second narrated explainer video near the top of the README. The video is for users of AI coding agents, not for steplock contributors.

The video covers:

  • the problem: agents act fast and skip checks
  • the block, ack and retry loop, one step at a time
  • session memory (reset = "session") and start over every time (reset = "always")
  • writing a checklist in flow.mmd, including a branch
  • what a checklist can guard (push, merge, review), project or global scope, and supported agents

Files

  • docs/media/steplock-explained.mp4: 1080p60, H.264 + AAC, soft English subtitles (7.2 MB)
  • docs/media/steplock-explained-poster.png: poster frame
  • README.md: the poster links to the MP4, plus a text link

GitHub renders the poster image inline. Click it to open the MP4 player on the file page.

Verification

  • Contact sheets cover the full timeline. No text collides and no text crosses the frame edge.
  • Narration level: mean −23 dB, max −3 dB.
  • ffprobe shows video, audio and subtitle streams.

Kev gate (local Kev, /v1/systemone)

🤖 Generated with Claude Code

A 92-second video for users of AI coding agents. It shows the block,
ack and retry loop, session memory, the flow.mmd checklist with a
branch, which actions and projects a checklist guards, and the
supported agents. The README links a poster frame to the MP4. The MP4
carries soft English subtitles.

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