Repository navigation
docs: align render, fps and transcribe docs with the CLI - #6166
Conversation
- docs/guides/rendering.mdx: default render quality is `looks` (CRF 16), not `standard`. - docs/packages/cli.mdx, render --help (render.ts): default --output is the timestamped `renders/<project>_<YYYY-MM-DD>_<HH-MM-SS>.<ext>`. - skills/hyperframes-cli/references/preview-render.md: local --fps accepts 1-240 or a rational and defaults to the root data-fps, else 30; only lambda and cloudrun are limited to 24, 30, 60. - skills/hyperframes-cli/references/lint-validate-inspect.md: snapshot --range is documented as START,END like every other reference. - skills/media-use/references/audio.md, skills/media-use/audio/references/ transcribe.md, skills/hyperframes/references/captions.md: name the entry point for each transcription default (transcribe.mjs prefers Parakeet; `hyperframes transcribe` uses Parakeet when installed, else the small.en whisper model). - transcribe --model help text and docs/packages/cli.mdx: list `small` and `medium`, which the CLI already accepts. - skills-manifest.json: regenerated hashes for the three skills touched. — Jerrai
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
![heygengenesis[bot]](https://avatars.githubusercontent.com/in/2913576?s=60&v=4){kind=small}
There was a problem hiding this comment.
Verdict: REQUEST CHANGES · 1 blocker · 0 important · 0 nits
I checked every row in the table against the code and the other five hold: quality defaults to looks, the output path matches plan.ts and formatRenderOutputTimestamp, parseSnapshotRange splits on [,:], small and medium are pinned whisper models, and the engine wording matches transcribe.ts. The --fps row adds a new inaccuracy, though: the distributed renderers' list is missing 25 ↓
Scope
Read all 10 changed files end-to-end. CI was still running at review time and nothing had failed. No prior human or bot reviews.
Distributed renders accept 24, 25, 30 and 60 fps (DISTRIBUTED_FPS in packages/core/src/distributedFps.ts). - skills/hyperframes-cli/references/preview-render.md: the --fps note lists 24, 25, 30, 60 for lambda and cloudrun. - skills/hyperframes-cli/references/lambda.md, cloudrun.md: --fps lists include 25. - packages/cli/src/docs/rendering.md (`hyperframes docs rendering`): --fps said 24, 30 or 60 and --quality defaulted to standard; local render takes 1-240 or a rational, default root data-fps else 30, and the default quality is looks. - skills-manifest.json: regenerated hyperframes-cli hash. — Jerrai
jrusso1020
left a comment
jrusso1020
left a comment
There was a problem hiding this comment.
Reviewed at 6a313943. I checked every changed default and accepted value against the source at this commit:
render --qualitydefaults tolooks, and its help says CRF 16 (commands/render.ts:177-183).- The default output path is
renders/${project.name}_${timestamp}${ext}(render/plan.ts:448-456). render --fpsaccepts 1-240 or a rational, and the default comes fromresolveDefaultFpsArg(plan.ts:238).DISTRIBUTED_FPS = [24, 25, 30, 60](core/src/distributedFps.ts).lambda.tsandcloudrun.tsvalidate against it, so the24|25|30|60wording now inpreview-render.md,lambda.mdandcloudrun.mdis correct. The second commit resolves Genesis's 25 fps finding from the first head.lambda/cloudrun--qualityis stilldraft|standard|high(QUALITIESin both files), so leaving those references alone is right.parseSnapshotRangesplits on/[,:]/, so3,5is valid and3:5still parses.DEFAULT_MODEL = "small.en", andsmallandmediumare pinned models inwhisper/manager.ts. The engine wording matches theenginehelp intranscribe.ts.packages/cli/src/docs/rendering.mdnow matches the samerenderargs.
The only code change is two help strings, with no behavior change.
Genesis's CHANGES_REQUESTED at 8e566e2b still sets the review decision until Genesis re-reviews or someone dismisses it. CI at this head was mostly pending when I looked; 6 checks had passed and none had failed.
— Rames
The format hook rewrote skill markdown after the manifest hook had hashed it, leaving the hyperframes-cli hash stale. — Jerrai
There was a problem hiding this comment.
Verdict: APPROVE · 0 blocker · 0 important · 0 nits · 6a31394 → 74ccceb
1 resolved, 0 open, 0 new. The manifest is in sync (I checked locally and the CI job passed), and all workflows are green on this head.
Heads-up: the PR is now DIRTY. main changed the hyperframes-cli skill, so skills-manifest.json conflicts. Resolve by merging or rebasing, then rerun bun run --cwd packages/cli gen:skills-manifest rather than hand-picking a hash. That push needs CI to pass again.
…ift_fixes-10232026 # Conflicts: # skills-manifest.json
What
Aligns a handful of documented defaults and accepted values with what the CLI actually does. Each row below was checked against the code; the docs (and two CLI help strings) were wrong, not the behaviour.
docs/guides/rendering.mdxstandardquality"looks(CRF 16)packages/cli/src/commands/render.tsqualityarg,default: "looks"docs/packages/cli.mdx(rendertable),render --helpinpackages/cli/src/commands/render.tsrenders/<name>.mp4renders/<project>_<YYYY-MM-DD>_<HH-MM-SS>.<ext>packages/cli/src/commands/render/plan.ts:join(rendersDir, \${project.name}_${timestamp}${ext}`)`skills/hyperframes-cli/references/preview-render.md(--fps)30000/1001, default is the rootdata-fps, else 30; onlylambdaandcloudrunare limited to 24, 30, 60render.tsfpsarg andresolveDefaultFpsArginrender/plan.ts;DISTRIBUTED_FPSinlambda.ts/cloudrun.tsskills/hyperframes-cli/references/lint-validate-inspect.mdsnapshot --range 3:5, "--range START:END"3,5andSTART,END, as in the other references (:still parses)parseSnapshotRangeinpackages/cli/src/commands/snapshotSampling.tsand the--rangehelp text insnapshot.tsskills/media-use/references/audio.md,skills/media-use/audio/references/transcribe.md,skills/hyperframes/references/captions.mdsmall.en", without saying which entry point each meansscripts/transcribe.mjsdefaults to Parakeet;hyperframes transcribeuses Parakeet when installed (--engine auto), otherwise thesmall.enwhisper modelenginearg inpackages/cli/src/commands/transcribe.ts;DEFAULT_MODEL = "small.en"inpackages/cli/src/whisper/manager.tstranscribe --modelhelp text,docs/packages/cli.mdxtiny.en, base.en, small.en, medium.en, large-v3smallandmediumsmallis a pinned model inpackages/cli/src/whisper/manager.ts; the skills already tell users to pass it for non-English audioskills-manifest.jsonis regenerated for the three skills whose files changed (hyperframes,hyperframes-cli,media-use).Scope
Documentation and two help strings only; no behaviour change. No test pins either help string.
Checks run
bun packages/cli/scripts/gen-skills-manifest.ts --check: in syncbun scripts/lint-skills.ts: no issuesnode scripts/check-core-skills.mjs: passesnode scripts/check-docs-cli-commands.mjs: passes