Skip to content

docs: describe the html path for plans without Claude Motion - #28

Merged
umiyosh merged 1 commit into
masterfrom
docs/html-path-readme
Oct 25, 2026
Merged

umiyosh merged 1 commit into
masterfrom
docs/html-path-readme

Conversation

@umiyosh

@umiyosh umiyosh commented Oct 25, 2026

Copy link
Copy Markdown
Owner

Summary

Documents the html path in the README (en / ja), so users on plans without Claude Motion know motion-render works for them and how the two paths differ.

Closes #20. Part of #16 (Phase 3).

Changes

  • README.md / README.ja.md
    • The intro and the note no longer say a Team or Enterprise plan is required: Motion is used when the account has it, HTML otherwise
    • New section "Two ways to make the animation": plans, how the film is made, checks before rendering, what you can look at, extra setup
    • Requirements: Claude Code on any plan
    • Commands: kit and check; stills and build mention the layout check
    • Troubleshooting: a build stopped by the layout check, and the missing-font message of an html film
    • Security, Development and Layout cover html films (kit/, references/html-film.md, kit.ts, layout.ts, snapshot.js)
    • The auto mode line now says "Motion or HTML films"
  • Diagrams: step 3 says "Claude Motion, or HTML"; the Japanese diagram's subtitle, step 1 and bottom line no longer assume an existing Motion film
  • motion-render usage: check samples every 0.1 s and also reports small or faint text (it still said 0.2 s after feat(check): report small and low-contrast text and short stops in html films #27)
  • Test: the html CLI smoke test also writes stills with motion-render stills

CI smoke test on the html path

#20 asked for one. CI already runs the html film tests in headless Chromium (load, scene times, the same frame twice, the layout check, kit and check). This adds stills through the CLI.

Open questions of #16

Decided and recorded on #16: keep both paths; no local preview server.

Test plan

  • make check: lint, format, typecheck, 93 tests with the coverage gate, quality gates
  • Both diagrams rendered in Chromium and looked at: no text overflow
  • Statements in the README checked against the code (layout ok output, kit keeps index.html, the html page does not play by itself)
  • CI

@umiyosh
umiyosh merged commit cb4dc37 into master Oct 25, 2026
1 check passed
@umiyosh
umiyosh deleted the docs/html-path-readme branch October 25, 2026 13:23
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.

docs: document and test the html path (#16 Phase 3)

1 participant