Files
heygen-com--hyperframes/docs/docs.json
ukimsanov f2bd52650d docs: put the four front doors together, widen the column, drop accordions
Navigation: Start here now holds exactly the four entry points a person can be
sent - what it is, make one, choose a workflow, and the Studio overview. The
three pages that were sitting in it went where they belong: the project tour is
conceptual so it moved to Learn, authentication is configuration so it moved to
Developers, and the hosted AI-chat route is a creation surface so it moved to
Create with an agent.

Width: the theme capped the article shell at 72rem and reserved 28rem of every
wide viewport for the contents rail, leaving the reading column at ~664px on a
1600px screen - narrower than the 16:9 video the pages are supposed to show.
Raised the shell and returned 9rem from the gutter, taking the column to roughly
950px. Running prose is held near 80 characters because longer lines measurably
hurt reading; tables, cards, code, and media use the full width. Added .hf-wide
for visuals that should escape the measure entirely.

Components: the quickstart source chooser is now Tabs, which is what parallel
variants of one instruction want, and the help symptoms are visible sections with
their own anchors so support can link a symptom directly instead of the hub.
Wrote the doctrine into AGENTS.md - one component per job, cards never point at
anchors on their own page, no diagram that restates adjacent prose, and the rules
for custom React snippets (named exports, no third-party packages, no CDN).
2026-07-29 14:50:12 -07:00

573 lines
17 KiB
JSON

{
"$schema": "https://mintlify.com/docs.json",
"name": "HyperFrames",
"theme": "aspen",
"colors": {
"primary": "#0a0a0a",
"light": "#f6f5f1",
"dark": "#0a0a0a"
},
"background": {
"color": {
"light": "#f6f5f1",
"dark": "#0a0a0a"
}
},
"fonts": {
"family": "Inter",
"heading": {
"family": "Inter"
}
},
"appearance": {
"default": "system"
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg",
"href": "https://hyperframes.heygen.com/introduction"
},
"favicon": "/favicon.svg",
"contextual": {
"options": [
"copy",
"claude",
"cursor",
"vscode",
"windsurf",
"mcp",
{
"title": "Open an issue",
"description": "Report a bug or request a feature",
"icon": "github",
"iconType": "brands",
"href": "https://github.com/heygen-com/hyperframes/issues/new"
}
]
},
"navigation": {
"tabs": [
{
"tab": "Guides",
"icon": "book-open",
"groups": [
{
"group": "Start here",
"pages": [
"introduction",
"quickstart",
"workflows",
"studio/index"
]
},
{
"group": "Create with an agent",
"pages": [
"guides/prompting",
"guides/mcp",
"guides/pipeline",
"guides/design-tools",
"guides/figma"
]
},
{
"group": "Workflows",
"pages": [
"guides/product-launch-video",
"guides/faceless-explainer",
"guides/pr-to-video",
"guides/captions-and-recuts",
"guides/motion-graphics",
"guides/music-to-video",
"guides/slideshow",
"guides/general-video"
]
},
{
"group": "Learn",
"pages": [
"concepts/index",
"guides/project-tour",
"concepts/compositions",
"concepts/variables",
"concepts/data-attributes",
"concepts/frame-adapters",
"concepts/determinism",
"guides/html-in-canvas",
"guides/hyperframes-vs-remotion"
]
},
{
"group": "Media",
"pages": [
"guides/media",
"guides/video-components",
"guides/voice-and-audio",
"guides/transcribe-and-caption",
"guides/remove-background",
"guides/color-grading",
"guides/media-effects",
"guides/media-overlays"
]
},
{
"group": "Export and share",
"pages": [
"guides/export-and-share",
"guides/quality-checklist",
"guides/publish-and-share",
"guides/rendering",
"guides/4k-rendering",
"guides/hdr",
"guides/performance"
]
},
{
"group": "Examples",
"pages": [
"examples"
]
},
{
"group": "Help",
"pages": [
"help",
"guides/common-questions",
"guides/troubleshooting",
"guides/feedback"
]
},
{
"group": "What's new",
"pages": [
"product-updates",
"weekly-updates",
"changelog"
]
}
]
},
{
"tab": "Studio",
"icon": "palette",
"groups": [
{
"group": "Overview",
"pages": [
"studio/index",
"studio/tour"
]
},
{
"group": "Review",
"pages": [
"studio/storyboard"
]
},
{
"group": "Edit",
"pages": [
"studio/canvas",
"studio/layers",
"studio/timeline",
"studio/design",
"studio/animation"
]
},
{
"group": "Build",
"pages": [
"studio/assets-and-blocks",
"studio/captions",
"studio/variables",
"studio/slideshows",
"studio/source"
]
},
{
"group": "Finish",
"pages": [
"studio/lint-and-agent",
"studio/export",
"studio/shortcuts",
"studio/troubleshooting"
]
}
]
},
{
"tab": "Catalog",
"icon": "grid-2",
"groups": [
{
"group": "Overview",
"pages": [
"catalog/index"
]
},
{
"group": "Code Animations",
"pages": [
"catalog/blocks/code-3d-extrude",
"catalog/blocks/code-diff",
"catalog/blocks/code-highlight",
"catalog/blocks/code-morph",
"catalog/blocks/code-particle-assemble",
"catalog/blocks/code-scroll",
"catalog/blocks/code-shader-dissolve",
"catalog/blocks/code-snippet-flight",
"catalog/blocks/code-typing"
]
},
{
"group": "Captions",
"pages": [
"catalog/components/caption-clip-wipe",
"catalog/components/caption-editorial-emphasis",
"catalog/components/caption-emoji-pop",
"catalog/components/caption-glitch-rgb",
"catalog/components/caption-gradient-fill",
"catalog/components/caption-highlight",
"catalog/components/caption-kinetic-slam",
"catalog/components/caption-matrix-decode",
"catalog/components/caption-neon-accent",
"catalog/components/caption-neon-glow",
"catalog/components/caption-parallax-layers",
"catalog/components/caption-particle-burst",
"catalog/components/caption-pill-karaoke",
"catalog/components/caption-texture",
"catalog/components/caption-weight-shift"
]
},
{
"group": "HTML-in-Canvas",
"pages": [
"catalog/blocks/ios26-liquid-glass",
"catalog/blocks/liquid-glass-context-menu",
"catalog/blocks/liquid-glass-media-controls",
"catalog/blocks/liquid-glass-notification",
"catalog/blocks/liquid-glass-widgets",
"catalog/blocks/macos-tahoe-liquid-glass",
"catalog/blocks/vfx-iphone-device",
"catalog/blocks/vfx-liquid-background",
"catalog/blocks/vfx-liquid-glass",
"catalog/blocks/vfx-magnetic",
"catalog/blocks/vfx-portal",
"catalog/blocks/vfx-shatter",
"catalog/blocks/vfx-text-cursor"
]
},
{
"group": "Social Overlays",
"pages": [
"catalog/blocks/instagram-follow",
"catalog/blocks/macos-notification",
"catalog/blocks/reddit-post",
"catalog/blocks/spotify-card",
"catalog/blocks/tiktok-follow",
"catalog/blocks/x-post",
"catalog/blocks/yt-lower-third"
]
},
{
"group": "Lower Thirds",
"pages": [
"catalog/blocks/lower-third-bild",
"catalog/blocks/lt-accent-underline",
"catalog/blocks/lt-bold-block",
"catalog/blocks/lt-clean-bar",
"catalog/blocks/lt-color-block",
"catalog/blocks/lt-dark-card",
"catalog/blocks/lt-kicker-name",
"catalog/blocks/lt-mask-reveal",
"catalog/blocks/lt-side-rule",
"catalog/blocks/lt-soft-pill",
"catalog/blocks/lt-stack-bars",
"catalog/blocks/news-ticker"
]
},
{
"group": "Shader Transitions",
"pages": [
"catalog/blocks/chromatic-radial-split",
"catalog/blocks/cinematic-zoom",
"catalog/blocks/cross-warp-morph",
"catalog/blocks/domain-warp-dissolve",
"catalog/blocks/flash-through-white",
"catalog/blocks/glitch",
"catalog/blocks/gravitational-lens",
"catalog/blocks/light-leak",
"catalog/blocks/ridged-burn",
"catalog/blocks/ripple-waves",
"catalog/blocks/sdf-iris",
"catalog/blocks/swirl-vortex",
"catalog/blocks/thermal-distortion",
"catalog/blocks/whip-pan"
]
},
{
"group": "CSS Transitions",
"pages": [
"catalog/blocks/transitions-3d",
"catalog/blocks/transitions-blur",
"catalog/blocks/transitions-cover",
"catalog/blocks/transitions-destruction",
"catalog/blocks/transitions-dissolve",
"catalog/blocks/transitions-distortion",
"catalog/blocks/transitions-grid",
"catalog/blocks/transitions-light",
"catalog/blocks/transitions-mechanical",
"catalog/blocks/transitions-other",
"catalog/blocks/transitions-push",
"catalog/blocks/transitions-radial",
"catalog/blocks/transitions-scale"
]
},
{
"group": "Showcases",
"pages": [
"catalog/blocks/app-showcase",
"catalog/blocks/apple-money-count",
"catalog/blocks/blue-sweater-intro-video",
"catalog/blocks/code-snippet-apple-terminal-basic",
"catalog/blocks/code-snippet-apple-terminal-clear-dark",
"catalog/blocks/code-snippet-apple-terminal-clear-light",
"catalog/blocks/code-snippet-apple-terminal-grass",
"catalog/blocks/code-snippet-apple-terminal-homebrew",
"catalog/blocks/code-snippet-apple-terminal-man-page",
"catalog/blocks/code-snippet-apple-terminal-novel",
"catalog/blocks/code-snippet-apple-terminal-ocean",
"catalog/blocks/code-snippet-apple-terminal-pro",
"catalog/blocks/code-snippet-apple-terminal-red-sands",
"catalog/blocks/code-snippet-apple-terminal-silver-aerogel",
"catalog/blocks/code-snippet-apple-terminal-solid-colors",
"catalog/blocks/code-snippet-dark-2026",
"catalog/blocks/code-snippet-dark-modern",
"catalog/blocks/code-snippet-dark-plus",
"catalog/blocks/code-snippet-high-contrast",
"catalog/blocks/code-snippet-high-contrast-light",
"catalog/blocks/code-snippet-light-2026",
"catalog/blocks/code-snippet-light-modern",
"catalog/blocks/code-snippet-light-plus",
"catalog/blocks/code-snippet-monokai",
"catalog/blocks/code-snippet-solarized-light",
"catalog/blocks/code-snippet-visual-studio-dark",
"catalog/blocks/code-snippet-visual-studio-light",
"catalog/blocks/north-korea-locked-down",
"catalog/blocks/nyc-paris-flight",
"catalog/blocks/ui-3d-reveal",
"catalog/blocks/vpn-youtube-spot"
]
},
{
"group": "Data",
"pages": [
"catalog/blocks/data-chart",
"catalog/blocks/spain-map",
"catalog/blocks/us-map",
"catalog/blocks/us-map-bubble",
"catalog/blocks/us-map-flow",
"catalog/blocks/us-map-hex",
"catalog/blocks/world-map"
]
},
{
"group": "Effects",
"pages": [
"catalog/components/caption-blend-difference",
"catalog/components/grain-overlay",
"catalog/components/grid-pixelate-wipe",
"catalog/components/morph-text",
"catalog/components/motion-blur",
"catalog/components/parallax-unzoom",
"catalog/components/parallax-zoom",
"catalog/components/shimmer-sweep",
"catalog/components/texture-mask-text",
"catalog/components/vignette"
]
},
{
"group": "Blocks",
"pages": [
"catalog/blocks/flowchart",
"catalog/blocks/flowchart-vertical",
"catalog/blocks/logo-outro"
]
}
]
},
{
"tab": "Developers",
"icon": "code",
"groups": [
{
"group": "Overview",
"pages": [
"developers/index"
]
},
{
"group": "Command line",
"pages": [
"developers/cli",
"packages/cli",
"packages/lint"
]
},
{
"group": "Agent setup",
"pages": [
"guides/authentication",
"guides/skills",
"guides/antigravity",
"guides/copilot-cli"
]
},
{
"group": "SDK",
"pages": [
"sdk/overview",
"sdk/quickstart",
"sdk/guides/querying-and-editing",
"sdk/guides/timing-and-animation",
"sdk/guides/undo-redo-and-patches",
"sdk/guides/persistence",
"sdk/guides/embedded-override-mode",
"sdk/guides/canvas-integration",
"sdk/guides/editing-affordances",
"sdk/reference/open-composition",
"sdk/reference/composition",
"sdk/reference/edit-operations",
"sdk/reference/types",
"sdk/reference/adapters",
"sdk/reference/utilities"
]
},
{
"group": "Packages",
"pages": [
"packages/core",
"packages/parsers",
"packages/studio-server",
"packages/sdk",
"packages/engine",
"packages/player",
"packages/producer",
"packages/shader-transitions",
"packages/studio"
]
},
{
"group": "Schema and animation",
"pages": [
"reference/html-schema",
"guides/gsap-animation",
"guides/keyframes"
]
},
{
"group": "Deployment",
"pages": [
"deploy/cloud",
"guides/deploy",
"deploy/aws-lambda",
"deploy/gcp-cloud-run",
"deploy/templates-on-lambda",
"deploy/migrating-to-hyperframes-lambda",
"packages/aws-lambda",
"packages/gcp-cloud-run"
]
},
{
"group": "Contributing",
"pages": [
"contributing",
"contributing/catalog",
"contributing/release-channels",
"contributing/changelog-process",
"contributing/testing-local-changes",
"community/adopters"
]
}
]
}
]
},
"footer": {
"socials": {
"github": "https://github.com/heygen-com/hyperframes"
}
},
"navbar": {
"links": [
{
"type": "github",
"href": "https://github.com/heygen-com/hyperframes"
}
],
"primary": {
"type": "button",
"label": "Playground",
"href": "https://www.hyperframes.dev/"
}
},
"redirects": [
{
"source": "/guides",
"destination": "/introduction"
},
{
"source": "/showcase",
"destination": "/examples"
},
{
"source": "/launch-videos",
"destination": "/examples"
},
{
"source": "/guides/claude-design",
"destination": "/guides/design-tools"
},
{
"source": "/guides/open-design",
"destination": "/guides/design-tools"
},
{
"source": "/guides/common-mistakes",
"destination": "/guides/troubleshooting"
},
{
"source": "/guides/create-with-agent",
"destination": "/workflows"
},
{
"source": "/guides/choose-your-path",
"destination": "/workflows"
},
{
"source": "/guides/help",
"destination": "/help"
},
{
"source": "/contributing/studio-manual-dom-editing",
"destination": "/studio/canvas"
},
{
"source": "/guides/video-editor-cheatsheet",
"destination": "/studio/shortcuts"
},
{
"source": "/guides/timeline-editing",
"destination": "/studio/timeline"
},
{
"source": "/guides/website-to-video",
"destination": "/guides/product-launch-video"
},
{
"source": "/weekly-updates",
"destination": "/changelog"
}
]
}