docs: audit and fix all documentation against actual codebase - #66
Merged
Conversation
Comprehensive audit of every documentation page against the actual source code, fixing incorrect APIs, wrong CLI flags, nonexistent templates, and missing public exports. Also documents the new agent-friendly CLI design. Key fixes: - Quickstart: `npx create-hyperframe` → `npx hyperframes init`, Node 20→22 - Templates: replaced nonexistent blank/title-card/video-edit with actual templates (blank, warm-grain, play-mode, swiss-grid, vignelli) - CLI: removed nonexistent short flags (-o/-f/-q/-w), added missing commands (browser, docs, telemetry, skills), documented agent-friendly non-interactive default and --human-friendly flag - Producer: replaced nonexistent `render()` API with actual `createRenderJob()`/`executeRenderJob()`, added server API docs - Engine: replaced nonexistent `createEngine()` with actual session-based API, added HfProtocol, encoding, streaming, parallel rendering docs - Core: fixed wrong type names (Composition/Clip→TimelineElement), wrong function names (parseHyperframeHtml→parseHtml), documented all 4 entry points (main, /lint, /compiler, /runtime) - Studio: added all missing exports (NLELayout, SourceEditor, PropertyPanel, FileTree, StudioApp, hooks, Tailwind preset) - All pages: --output not -o, Node 22+ not 20+ Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
miguel-heygen
approved these changes
Mar 26, 2026
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
2 participants
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.
Summary
Comprehensive audit of every documentation page against the actual source code. Fixes incorrect APIs, wrong CLI flags, nonexistent templates, missing public exports, and documents the new agent-friendly CLI design.
Fixes across all 11 doc files:
Quickstart
npx create-hyperframe→npx hyperframes init(package doesn't exist)--templateflag and--human-friendlyfor interactive modeTemplates
blank/title-card/video-edit) with actual templates (blank,warm-grain,play-mode,swiss-grid,vignelli)--videoflag documentation and project structure for each templateCLI
--human-friendlyopt-in-o,-f,-q,-w) — no aliases defined in citty argsbrowser,docs,telemetry,skillsinitwith new flags:--audio,--skip-skills,--skip-transcribe,--human-friendlyupgradewith new flags:--check,--yesProducer
render()API with actualcreateRenderJob()+executeRenderJob()RenderConfig,RenderStatus,RenderCancelledErrordocumentation@hyperframes/producer/serverexport)Engine
createEngine()with actual session-based API (createCaptureSession,captureFrame, etc.)window.__hfprotocol (HfProtocol/HfMediaElement) documentationCore
Composition/Clip→TimelineElement/CompositionSpec)parseHyperframeHtml→parseHtml,generateHyperframeHtml→generateHyperframesHtml)/lint,/compiler,/runtimeStudio
NLELayout,NLEPreview,CompositionBreadcrumb,SourceEditor,PropertyPanel,FileTree,StudioApp,AgentActivityTrackuseCodeEditor,useElementPicker,usePlayerStoreIntroduction
Rendering, Troubleshooting, Determinism
--outputeverywhere (not-o)Test plan
mintlify devfrom/docs)--helpoutputpackages/cli/src/templates/generators.ts🤖 Generated with Claude Code