Code explainer

Turn a pull request into a 60-second video

Paste the link to a pull request, a commit or a release post. The Director reads the change and makes a narrated video that shows what changed, why, and how the hardest part works, on the real code.

An example

1−++the fix

One commit, under a minute

A commit to ky, the HTTP client: “Let a beforeRetry hook change per-attempt options”, nine files and 543 lines, most of them tests. The video lists all of it, shows the upload that failed and why, then walks through the one method that makes it work.

What's in it

Four parts, always in this order

Overview
Every important change in one list, with where the lines went. The one explained in detail comes first.
Why it changed
The problem, before and after, in one line each. The part that matters is underlined as the voice says it.
Deep dive
The hardest or highest-impact change, walked through on the real code in the order it runs. Names light up as they're said, with a note or a definition where it helps.
Also in this change
What else the change does, listed, and a link and QR code to the full diff or post.

What the Director holds itself to

  • Under 60 seconds
  • Every number from the change
  • Highlighted code is in the diff
  • One change explained, the rest listed
  • The why from the change, never made up
  • A link to the full change

What it starts from

A link to the change

The Director reads the change from its link, so for now it must be in a public repository, or a post anyone can open.

Pull request
github.com/you/repo/pull/42
Commit
github.com/you/repo/commit/1a2b3c4
Release post
yourblog.com/announcing-v2

Frequently asked

Questions about code explainers

What is a code explainer video?

A narrated video under a minute that explains one code change. It lists everything the change does, shows the problem it solves, walks through the hardest part on the real code as the voice talks about it, and ends on a link and a QR code to the full change.

What can I make one from?

A GitHub pull request, a commit, or a technical release post (a "what's new" announcement with code samples). Paste its link. The Director reads the diff and the description, or the post's sections and samples.

Does it work with private repositories?

Not yet. For now the change must be in a public repository, or a post anyone can open: the Director reads it from the link alone.

How does it keep the video accurate?

Everything on screen comes from the change itself. Highlighted lines and names must be in the diff, every number must be one the change shows (files, lines, tests) or a quote from it, and the video must fit in 60 seconds. A storyboard that breaks a rule goes back to the Director before anything is voiced.

Who is it for?

Reviewers who want the gist of a pull request before reading it, teams sharing what shipped, and anyone announcing a release to developers. It is made to be skimmed: the one change that matters most, explained; the rest, listed.

Can I change the video?

Yes. Ask the Director in a sentence, like "explain the retry logic instead" or "underline the new option when it's named", and get a new version. Every earlier version stays.

Paste the link. The Director explains it.

Promoting a product instead? See all video types.