Repository navigation
docs(cli): list --format and the 24-worker cap in docs rendering - #7716
Merged
miguel-heygen merged 1 commit intoNov 14, 2026
Merged
Conversation
`hyperframes docs rendering` said workers run 1-8, but the engine clamps an explicit value to 24, and it never mentioned --format or --gif-loop. The options now match render.ts and the engine limit. Fixes heygen-com#7668
miguel-heygen
approved these changes
Nov 14, 2026
miguel-heygen
left a comment
miguel-heygen
left a comment
Collaborator
There was a problem hiding this comment.
Docs match the code on main: the engine caps workers at ABSOLUTE_MAX_WORKERS = 24 (parallelCoordinator.ts), and --format / --gif-loop wording and default come from their option definitions in commands/render.ts. CI green.
Merged
1 of 2 tasks
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.
What
hyperframes docs renderingnow lists--formatand--gif-loop, and gives the real--workersrange.Why
The page said workers run 1-8, but the engine accepts up to 24. It also never mentioned
--format, so readers couldn't learn thatrendercan also outputwebm,mov,gif,png-sequenceandhls.Related work
Fixes #7668
How
packages/cli/src/docs/rendering.mdonly:--workers: 1-24 orauto. The CLI accepts any positive integer (commands/render/plan.ts), and the engine clamps an explicit value toABSOLUTE_MAX_WORKERS = 24(packages/engine/src/services/parallelCoordinator.ts). So the line says higher values are capped, not rejected.--formatand--gif-loop: wording and default (mp4) taken from their option definitions inpackages/cli/src/commands/render.ts.Test plan
commands/docs.test.tspasses (3 tests).hyperframes docs renderingfrom source and checked that the new lines read cleanly in the terminal output.