Repository navigation
feat(kit): write film/kit/API.md, one page of what a film page can call - #106
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #93. Part of #87.
Summary
motion-render kitnow writesfilm/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:
beat.ease.backas a value, though it returns an easing.fx.canvas's return value and the font weights still had to be looked up in the source.Change
scripts/kitapi.tsreferences/html-film.md, so it never disagrees with the guide. The fonts come from thefonts.cssthe kit just wrote. It adds the two notes that cost time:fx.canvasreturns a 2D context, andbeat.ease.back(1.7)(p).scripts/kit.tswriteKitwriteskit/API.mdreferences/html-film.mdfilm.total,film.timeline,film.frameTime,beat.bpm,beat.beat,beat.hits,beat.at,beat.hold. Also notes howbeat.ease.backis called.skills/rich/SKILL.md, step 5film/kit/API.mdTest
tests/kitapi.test.ts:window.film,window.fxandwindow.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.backnote, are on the page.make checkpasses.