Repository navigation
docs: hyperframes docs rendering lists 1-8 workers and never mentions --format #7668
Description
hyperframes docs rendering prints the render options from packages/cli/src/docs/rendering.md. Two things in that page are out of date:
- Worker range. Line 19 says
-w, --workers — Parallel workers 1-8 (default: auto). The engine actually accepts up to 24 workers (ABSOLUTE_MAX_WORKERS = 24inpackages/engine/src/services/parallelCoordinator.ts). - Output format. The page never mentions
--format, so a reader can't learn from it thatrenderalso produceswebm,mov,gif,png-sequenceandhls. The accepted values are listed in theformatoption and the examples at the top ofpackages/cli/src/commands/render.ts.
What to do
- Fix the
--workersline so it matches what the engine accepts. - Add a
--formatbullet to the Options list, plus--gif-loopif it fits, usingrender.tsas the source of truth. - Run
hyperframes docs renderinglocally and check that the output reads well.
This is a docs-only change and a good first contribution.
— Rames Jusso
Activity
ksong151 commentedon Nov 13, 2026
Hi! I’d like to take this one if it’s still available.
Here’s my plan, all in packages/cli/src/docs/rendering.md:
--workers: change “1-8” to “1-24”. Add that values above 24 are clamped, since ABSOLUTE_MAX_WORKERS = 24 in parallelCoordinator.ts clamps them instead of rejecting them.
--format: add a bullet listing mp4 (default), webm, mov, gif, png-sequence and hls. Note that MOV and WebM keep transparency and that png-sequence and hls write a directory, using the option description in render.ts as the source.
--gif-loop: add a bullet: loop count from 0 to 65535, where 0 means infinite, used only with --format gif.
Change the opening line “Render compositions to MP4” so it doesn’t contradict the new formats.
Then I’ll run hyperframes docs rendering locally to check the output, and run the docs command tests.
docs(cli): list --format and the 24-worker cap in docs rendering (hey…