Skip to content

feat(kit): write film/kit/API.md, one page of what a film page can call - #106

Merged
umiyosh merged 1 commit into
masterfrom
feat/issue-93-kit-api
Nov 18, 2026
Merged

umiyosh merged 1 commit into
masterfrom
feat/issue-93-kit-api

Conversation

@umiyosh

@umiyosh umiyosh commented Nov 17, 2026

Copy link
Copy Markdown
Owner

Fixes #93. Part of #87.

Summary

motion-render kit now writes film/kit/API.md: one page with everything a film page can call (film, fx, beat) and the fonts with their weights. Step 5 of the rich skill points to it.

Why

The kit's functions were documented in tables spread across a 700-line guide:

Change

File Change
scripts/kitapi.ts Builds the page from the three tables in references/html-film.md, so it never disagrees with the guide. The fonts come from the fonts.css the kit just wrote. It adds the two notes that cost time: fx.canvas returns a 2D context, and beat.ease.back(1.7)(p).
scripts/kit.ts writeKit writes kit/API.md
references/html-film.md Adds the names the tables were missing: film.total, film.timeline, film.frameTime, beat.bpm, beat.beat, beat.hits, beat.at, beat.hold. Also notes how beat.ease.back is called.
skills/rich/SKILL.md, step 5 Read the kit's API in film/kit/API.md

Test

  • New tests/kitapi.test.ts:
    • Every key of window.film, window.fx and window.beat, read from the kit's source, is on the page. A function added to the kit without a line in the guide fails here.
    • The fonts and weights, and the back note, are on the page.
  • make check passes.

@umiyosh
umiyosh merged commit beba557 into master Nov 18, 2026
1 check passed
@umiyosh
umiyosh deleted the feat/issue-93-kit-api branch November 18, 2026 16:14
@umiyosh umiyosh mentioned this pull request Nov 18, 2026
1 of 2 tasks
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.

kit: write a short API page from the kit's own comments

1 participant