docs: implement journey-led documentation

This commit is contained in:
ukimsanov
2026-07-28 22:44:16 -07:00
parent 4085527cb4
commit c5be64e1a7
26 changed files with 1333 additions and 484 deletions
+27 -15
View File
@@ -7,40 +7,52 @@ The Catalog is a library of visuals you can add to a project instead of building
Use a **block** when you want a larger scene or self-contained visual. Use a **component** when you want a smaller effect or behavior inside an existing scene.
## Find the right starting point
## Start with the job
<CardGroup cols={2}>
<Card title="Code animations" icon="code" href="/catalog/blocks/code-typing">
Typing, diffs, highlights, editor scenes, terminal scenes, and 3D code treatments.
Show code being typed, changed, highlighted, scrolled, or transformed.
</Card>
<Card title="Captions" icon="closed-captioning" href="/catalog/components/caption-highlight">
Readable subtitle styles and more expressive word-level treatments.
Keep speech readable or emphasize selected words without designing a caption system from zero.
</Card>
<Card title="Transitions" icon="arrows-left-right" href="/catalog/blocks/cinematic-zoom">
CSS and shader transitions for moving between scenes.
Move between scenes with a quiet cut treatment or a more expressive transition.
</Card>
<Card title="Social overlays" icon="share-nodes" href="/catalog/blocks/x-post">
Posts, follow prompts, notifications, lower thirds, and platform-inspired cards.
Show posts, follow prompts, notifications, names, roles, and platform-inspired cards.
</Card>
<Card title="Data and maps" icon="chart-column" href="/catalog/blocks/data-chart">
Charts, counters, maps, and geographic flows.
Explain a number, comparison, trend, location, or geographic movement.
</Card>
<Card title="Showcase scenes" icon="play" href="/catalog/blocks/app-showcase">
Larger examples that combine design, media, and animation.
Start from a larger scene that already combines design, media, and animation.
</Card>
</CardGroup>
## Add an item
## Use an item in a real project
Each catalog page shows what the item does and where it belongs. Ask your agent to add it, or use the command shown on the item page.
1. Open an item and watch the motion preview.
2. Check that its communication job matches the scene.
3. Copy the plain-language request from the item page into your agent chat.
4. Replace the example content with real project content.
5. Match the project's type, color, spacing, and motion language.
6. Review the item inside the complete video, not only in isolation.
After adding an item:
The terminal command and source details remain available on each item page for people who need them.
1. Replace its example content with your real content.
2. Match the colors and type to your project.
3. Check timing in the complete video, not only in isolation.
4. Keep the parts that serve the story; remove decorative motion that does not.
## Before you keep it
<Note>
Catalog items are starting points. A good result usually needs content, timing, and styling changes to feel native to your project.
A Catalog item is a starting point, not a finished design decision. Keep it only when it makes the scene clearer or faster to understand. Remove decorative motion that competes with the story.
</Note>
Check:
- Can the viewer understand why the visual is present?
- Is the real content readable at the final size?
- Does its timing fit the scenes around it?
- Does it feel like part of this project rather than a pasted demo?
- Is a quieter alternative more effective?
[Learn how to add Catalog items in Studio →](/studio/assets-and-blocks)
+38 -16
View File
@@ -7,33 +7,55 @@ This section is for people integrating HyperFrames, automating it, extending the
If you only want to create or edit a video, begin with [Guides](/guides) or [Studio](/studio).
## Choose the smallest surface
```mermaid
flowchart TD
A["What does your system need to do?"] --> B["Run commands or CI jobs"]
A --> C["Inspect or edit compositions in an app"]
A --> D["Embed playback"]
A --> E["Operate custom render infrastructure"]
A --> F["Generate or validate raw composition source"]
B --> G["CLI"]
C --> H["SDK"]
D --> I["Player"]
E --> J["Focused packages and deployment guides"]
F --> K["HTML schema and animation reference"]
```
<CardGroup cols={2}>
<Card title="CLI" icon="terminal" href="/developers/cli">
Choose the command for creating, checking, rendering, publishing, and automating projects.
Create, check, render, publish, and automate projects from a terminal or CI job.
</Card>
<Card title="SDK" icon="code" href="/sdk/overview">
Query and edit compositions, persist changes, and build custom editing surfaces.
<Card title="SDK quickstart" icon="code" href="/sdk/quickstart">
Open a composition, query or edit it, persist changes, and build custom editing surfaces.
</Card>
<Card title="Player" icon="circle-play" href="/packages/player">
Embed a seekable HyperFrames composition and control playback from an application.
</Card>
<Card title="Packages" icon="boxes-stacked" href="/packages/core">
Use the framework as focused packages for parsing, playback, rendering, Studio, and infrastructure.
</Card>
<Card title="HTML schema" icon="brackets-curly" href="/reference/html-schema">
Reference the composition elements, timing attributes, tracks, variables, and media contract.
Add focused parsing, playback, rendering, Studio, or infrastructure capabilities.
</Card>
<Card title="Deployment" icon="cloud" href="/deploy/cloud">
Render with managed cloud infrastructure, AWS Lambda, or Google Cloud Run.
</Card>
<Card title="Contributing" icon="code-pull-request" href="/contributing">
Work on the framework, Catalog, tests, and releases.
<Card title="HTML schema" icon="brackets-curly" href="/reference/html-schema">
Reference composition elements, timing attributes, tracks, variables, and the media contract.
</Card>
</CardGroup>
## Start with the smallest surface
## A good first technical result
- Use the **CLI** for normal project and render automation.
- Use the **SDK** when your application needs to inspect or edit compositions.
- Use the **Player** when you need embedded playback.
- Install individual **packages** when you are building infrastructure or a custom product surface.
- Read the raw **schema** when generating or validating composition source.
Choose one result rather than installing the whole repository:
Most applications do not need to depend on every package.
- render one known project from a script or CI job;
- open one composition with the SDK and change one value;
- embed one project with the Player and seek to a timestamp;
- deploy one minimal render path;
- validate one generated composition against the schema.
Continue to package or reference pages only when that working path requires more control. Most integrations should not depend on every HyperFrames package.
## Working on HyperFrames itself?
Use [Contributing](/contributing) for repository setup, tests, Catalog contributions, and releases. Product integrations should begin with one of the surfaces above instead.
+24 -10
View File
@@ -57,7 +57,7 @@
"guides/index",
"introduction",
"quickstart",
"guides/choose-your-path",
"workflows",
"guides/project-tour",
"guides/authentication",
"guides/mcp"
@@ -66,17 +66,10 @@
{
"group": "Create with an agent",
"pages": [
"guides/create-with-agent",
"guides/skills",
"guides/prompting",
"guides/pipeline",
"guides/design-tools",
"guides/claude-design-hyperframes",
"guides/claude-design-send-to-hyperframes",
"guides/open-design-hyperframes",
"guides/figma",
"guides/antigravity",
"guides/copilot-cli"
"guides/figma"
]
},
{
@@ -88,6 +81,7 @@
"guides/captions-and-recuts",
"guides/motion-graphics",
"guides/music-to-video",
"guides/slideshow",
"guides/general-video"
]
},
@@ -138,7 +132,7 @@
{
"group": "Help",
"pages": [
"guides/help",
"help",
"guides/common-questions",
"guides/troubleshooting",
"guides/feedback"
@@ -421,6 +415,14 @@
"packages/lint"
]
},
{
"group": "Agent setup",
"pages": [
"guides/skills",
"guides/antigravity",
"guides/copilot-cli"
]
},
{
"group": "SDK",
"pages": [
@@ -530,6 +532,18 @@
"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"
+30
View File
@@ -31,6 +31,17 @@ and a side panel for the two statistics mentioned in the transcript.
The recut workflow uses the transcript to place designed information around the existing clip.
## Approve the treatment
Confirm:
- whether the footage and audio must remain untouched;
- the aspect ratio and safe space around the speaker;
- caption density, line length, and emphasis style;
- names, titles, terms, and numbers that need manual verification;
- which moments deserve overlays;
- whether the result must work without sound.
## Review
- Correct names and wording before styling.
@@ -40,3 +51,22 @@ The recut workflow uses the transcript to place designed information around the
- Watch once with sound and once muted.
Use [Captions in Studio](/studio/captions) for text, timing, and style changes.
## Common problems
| Problem | Better direction |
| --- | --- |
| Every spoken word is emphasized | Reserve emphasis for the few words that change meaning. |
| Overlays cover the speaker or source footage | Establish safe regions before styling. |
| A pull quote repeats the caption underneath | Use overlays to add structure or context. |
| Captions are correct but too fast to read | Reduce words per line and adjust holds. |
| The request actually needs speech editing | Use the custom video workflow and say the footage may change. |
<CardGroup cols={2}>
<Card title="Edit captions in Studio" icon="closed-captioning" href="/studio/captions">
Correct words, timing, and visual treatment.
</Card>
<Card title="Choose another workflow" icon="route" href="/workflows">
Return to the source-and-outcome chooser.
</Card>
</CardGroup>
-39
View File
@@ -1,39 +0,0 @@
---
title: "Choose your path"
description: "Decide whether to begin with an agent, Studio, the Catalog, or developer tools."
---
There is no single required way to use HyperFrames. Start from what you already have and what you are trying to accomplish.
| You have | Start here | Why |
| --- | --- | --- |
| You want to explore without local setup | [Browser Playground](https://www.hyperframes.dev/) | Open and remix public HyperFrames work in the browser. |
| You want to create inside a supported AI chat | [HyperFrames MCP](/guides/mcp) | Use a hosted connector and cloud rendering without the local CLI. |
| An idea, URL, script, PR, song, or video file | [Create with an agent](/guides/create-with-agent) | The agent can choose the right workflow and build the first version. |
| A HyperFrames project you want to review or edit | [Studio](/studio) | Studio is the visual workspace for timing, design, animation, and export. |
| A specific effect or scene you want to reuse | [Catalog](/catalog) | Browse ready-made blocks and components instead of rebuilding them. |
| An application or automation you want to integrate | [Developers](/developers) | Use the CLI, SDK, player, packages, schemas, and deployment tools. |
## Agent or Studio?
Most projects use both.
Use the **agent** when the change needs planning, new scenes, new media, source-code work, or coordination across the project.
Use **Studio** when you can point at what you want to change: move an element, edit text, trim timing, adjust a keyframe, change a style, or export a version.
<Tip>
A useful rule: if you can fix it by selecting something visible, try Studio. If you need to explain a broader outcome, ask the agent.
</Tip>
## Catalog or custom work?
Use the Catalog when a reusable visual already matches the job: a lower third, transition, chart, caption style, social card, or code animation.
Ask the agent for custom work when the visual needs to carry your particular story, product interface, brand system, or data.
## Human guide or developer reference?
The **Guides** and **Studio** sections explain what to do and what you should see.
The **Developers** section explains commands, APIs, packages, schemas, deployment, and implementation details. You should not need it for normal review and editing.
+2 -2
View File
@@ -7,13 +7,13 @@ description: "Short answers to the questions people most often ask when they beg
No. Most people can describe the result they want, let an agent build it, and use Studio to review and adjust the result.
You may still see project files and terminal commands because those are how the agent and HyperFrames work underneath. Start with [Create with an agent](/guides/create-with-agent).
You may still see project files and terminal commands because those are how the agent and HyperFrames work underneath. Start with [Make your first video](/quickstart).
## What can I make?
HyperFrames can create product videos, explainers, motion graphics, captioned or recut footage, music-led videos, code-change videos, and interactive slideshows.
Use [Choose your path](/guides/choose-your-path) to find the shortest workflow for your input.
Use [Choose a creation workflow](/workflows) to find the shortest path for your input.
## How do I open Studio?
-105
View File
@@ -1,105 +0,0 @@
---
title: "Create with an agent"
sidebarTitle: "Overview"
description: "Give an AI agent the right input and let HyperFrames choose the matching creation workflow."
---
You do not need to memorize the HyperFrames workflows. Start with `/hyperframes`, describe the result, and let the router choose.
## Install once
```bash
npx hyperframes skills update
```
Then begin your request with `/hyperframes`.
## Choose by what you have
| Starting material | Ask for | HyperFrames workflow |
| --- | --- | --- |
| A product URL, website, app, or launch brief | A promo, launch video, site tour, or product showcase | Product launch video |
| Notes, an article, or a topic without a product site | A visual explainer with invented visuals | Faceless explainer |
| A GitHub pull request | A change summary, feature reveal, or fix explanation | PR to video |
| Talking-head footage that only needs subtitles | Captions without changing the footage | Embedded captions |
| Talking-head, interview, or podcast footage | Designed titles, quotes, lower thirds, and information overlays | Talking-head recut |
| A short motion-first idea | A title, statistic, chart, logo sting, or overlay | Motion graphics |
| A music track | A beat-synced lyric video, slideshow, or promo | Music to video |
| A presentation | An interactive deck with reveals, notes, and navigation | Slideshow |
| An existing Remotion composition | A source migration to HyperFrames HTML | Remotion to HyperFrames |
| Anything else | A custom video or composition | General video |
## Write a useful request
The agent needs direction, not a technical implementation.
```text
/hyperframes Create a 45-second product video for https://example.com.
The audience is small design teams. Focus on how quickly they can go
from an idea to a shared result. Use the real product interface, keep
the pacing confident rather than frantic, and end with “Try it together.”
```
Good information to include:
- **Goal:** what should the viewer understand, feel, or do?
- **Audience:** who is watching?
- **Source:** URL, file, text, PR, or music.
- **Format:** landscape, vertical, square, or presentation.
- **Length:** only when it matters.
- **Tone:** a few useful words, preferably with a reference.
- **Must-haves:** exact claims, visuals, words, or constraints.
Avoid filling the request with animation instructions unless a particular motion is essential. Let the first creative direction solve the communication problem.
## Review the brief before the build
For a fresh project, the agent confirms the direction before building. Check the message, audience, format, pacing, and required content.
This is the cheapest moment to correct a misunderstanding.
## Give feedback on the visible result
Useful feedback names the moment, the problem, and the desired effect:
```text
At the opening, I cannot tell what the product is until too late.
Show the interface by three seconds, but keep the first headline.
```
Less useful feedback describes a mood without locating the problem:
```text
Make it pop more.
```
You can combine both:
```text
The proof section feels flat. Keep the copy, but make the three numbers
arrive one at a time and hold long enough to read.
```
## Use Studio during the review
Open [Studio](/studio) to inspect the storyboard, play the project, select elements, adjust timing, edit animation, and export versions.
Ask the agent for changes that affect several scenes or require new assets. Make direct adjustments in Studio when the target is visible and specific.
## Install options for advanced users
<Accordion title="Pick or install every skill manually">
Open the interactive picker:
```bash
npx skills add heygen-com/hyperframes --full-depth
```
Install the full set only when you explicitly want every workflow available up front:
```bash
npx skills add heygen-com/hyperframes --all --full-depth
```
Agent and non-interactive environments should normally use `npx hyperframes skills update`.
</Accordion>
+32
View File
@@ -7,6 +7,8 @@ Use a faceless explainer when the source is an idea or piece of text—not a pro
The agent invents the visual language from typography, diagrams, abstract graphics, data visualization, icons, and generated media.
Use a [product and website video](/guides/product-launch-video) when the real product interface should provide the visual proof. Use captions or a recut when existing footage must remain underneath.
## Start with the point
```text
@@ -25,6 +27,17 @@ Include:
- whether narration is wanted;
- claims or examples that must remain exact.
## Approve the explanation before the visuals
Confirm:
- the question the opening creates;
- what the audience already knows;
- the minimum sequence needed to explain the idea;
- which facts or examples require verification;
- the visual language and narration choice;
- the one conclusion the viewer should remember.
## Review the explanation
Check the storyboard before judging visual polish:
@@ -36,3 +49,22 @@ Check the storyboard before judging visual polish:
5. Can the audience repeat the conclusion afterward?
Use the [Storyboard](/studio/storyboard) for the reasoning and [Studio](/studio) for timing, type, diagrams, and animation.
## Common problems
| Problem | Better direction |
| --- | --- |
| The visuals decorate but do not explain | Ask what each visual makes easier to understand. |
| Too many abstract claims arrive at once | Use one concrete example before the general rule. |
| The pace is fast because the script is crowded | Remove ideas rather than shortening every hold. |
| A generated statistic sounds authoritative | Verify the source or remove the claim. |
| Every scene uses a different visual metaphor | Choose a small, consistent visual system. |
<CardGroup cols={2}>
<Card title="Review in Studio" icon="palette" href="/studio">
Refine the storyboard, typography, diagrams, timing, and animation.
</Card>
<Card title="Choose another workflow" icon="route" href="/workflows">
Return to the source-and-outcome chooser.
</Card>
</CardGroup>
+31
View File
@@ -24,6 +24,18 @@ Use this route when:
- the structure is deliberately unusual;
- you want to co-direct the work rather than hand over one narrow task.
## Approve the production shape
Because this route is flexible, agree on more before the build:
- the final deliverable and audience;
- source material and usage constraints;
- story structure and approximate length;
- whether existing footage may be edited;
- narration, music, and sound direction;
- review checkpoints;
- aspect ratios and required versions.
## Keep the review loop clear
1. Agree on the brief.
@@ -33,3 +45,22 @@ Use this route when:
5. Validate and export.
Studio and the agent are complementary. Make direct visible changes in [Studio](/studio); use the agent for changes that cross scenes, files, media, or the overall story.
## Common problems
| Problem | Better direction |
| --- | --- |
| “Custom” becomes permission to skip the brief | Agree on the outcome and checkpoints before exploring. |
| Story and visual feedback are mixed together | Fix message and structure before polishing motion. |
| Every source file is included | Keep only material that serves the final narrative. |
| Multiple aspect ratios are treated as simple crops | Plan layout changes for each required format. |
| The scope keeps expanding | Name a reviewable first version and defer optional ideas. |
<CardGroup cols={2}>
<Card title="Review in Studio" icon="palette" href="/studio">
Inspect the whole result, make direct edits, and export versions.
</Card>
<Card title="Choose a focused workflow" icon="route" href="/workflows">
Return to the chooser when a narrower creation path would work better.
</Card>
</CardGroup>
-34
View File
@@ -1,34 +0,0 @@
---
title: "Get help"
sidebarTitle: "Overview"
description: "Find the problem, collect useful evidence, and get a HyperFrames project moving again."
---
Start with what you can observe. Copy the exact error, note when it happens, and say whether the problem appears in Studio preview, during validation, or only in the final render.
<CardGroup cols={2}>
<Card title="Troubleshooting" icon="wrench" href="/guides/troubleshooting">
Work through project, preview, media, animation, and rendering failures.
</Card>
<Card title="Studio troubleshooting" icon="palette" href="/studio/troubleshooting">
Solve selection, timeline, preview, editing, and export problems.
</Card>
<Card title="Give feedback" icon="comment" href="/guides/feedback">
Report a bug or explain a product problem with enough context to act on it.
</Card>
<Card title="GitHub issues" icon="github" href="https://github.com/heygen-com/hyperframes/issues">
Search known issues or open a new report.
</Card>
</CardGroup>
## What to include when asking for help
- What you were trying to do.
- The command or visible action you took.
- The exact error or unexpected result.
- Whether it happens every time.
- Your operating system and HyperFrames version.
- A screenshot or short recording when the problem is visual.
- A small reproducible project when the source can be shared.
Do not paste secrets, access tokens, private media, or credentials into a public issue.
+26 -15
View File
@@ -1,28 +1,39 @@
---
title: "Guides"
title: "What do you need to do?"
sidebarTitle: "Overview"
description: "Practical help for creating, reviewing, exporting, and sharing work made with HyperFrames."
description: "Choose the shortest HyperFrames documentation path for what you need right now."
---
Use these guides when you want to finish a task. You can begin with an idea, a website, existing footage, a pull request, a music track, or a project an agent already created.
You do not need to read these docs from beginning to end. Start from your current situation.
<CardGroup cols={2}>
<Card title="Start here" icon="play" href="/introduction">
Understand the product and make your first video.
<Card title="I do not know what HyperFrames is" icon="circle-info" href="/introduction">
Understand the product, see a finished result, and choose a relevant next step.
</Card>
<Card title="Create with an agent" icon="sparkles" href="/guides/create-with-agent">
Choose a workflow, write a useful request, and improve the result.
<Card title="I want to make my first video" icon="play" href="/quickstart">
Go from source material to a reviewable project in Studio and export it.
</Card>
<Card title="Learn the basics" icon="book-open" href="/concepts">
Understand compositions, timing, variables, animation, and reliable rendering.
<Card title="I need to make something specific" icon="route" href="/workflows">
Choose the right path for a product, idea, recording, pull request, motion graphic, song, or presentation.
</Card>
<Card title="Work with media" icon="photo-film" href="/guides/media">
Use images, footage, audio, captions, backgrounds, and color.
<Card title="I already have a project" icon="palette" href="/studio">
Review the storyboard, make direct edits, adjust timing and animation, or export a version.
</Card>
<Card title="Export and share" icon="arrow-up-from-bracket" href="/guides/export-and-share">
Choose the right format, resolution, and delivery method.
<Card title="Something is not working" icon="life-ring" href="/help">
Start with the visible symptom and return to the task you were trying to finish.
</Card>
<Card title="Get help" icon="life-ring" href="/guides/help">
Solve common problems and send useful feedback.
<Card title="I am integrating HyperFrames" icon="code" href="/developers">
Choose the CLI, SDK, Player, package, schema, or deployment surface you actually need.
</Card>
</CardGroup>
## Useful places after the first task
- [Examples](/examples) — watch finished work, inspect production projects, or start from a template.
- [Catalog](/catalog) — find reusable scenes, captions, transitions, overlays, and effects.
- [Learn](/concepts) — understand compositions, timing, variables, adapters, and deterministic rendering.
- [What's new](/product-updates) — follow product changes without reading the technical release archive.
<Note>
If a teammate asks “What is HyperFrames?”, send [What is HyperFrames?](/introduction), not this directory page.
</Note>
+30
View File
@@ -27,4 +27,34 @@ Include the exact words or data, intended background, dimensions, duration, and
If the piece needs several scenes, narration, or a longer story, use the General Video workflow instead.
## Approve the motion idea
Confirm:
- the one message or number;
- the exact duration and dimensions;
- where the graphic will be used;
- the background or transparency requirement;
- the entrance, main action, and clean exit;
- whether the first or final frame must hold.
Review the first and final frames carefully. An overlay must enter and leave cleanly when placed over another edit.
## Common problems
| Problem | Better direction |
| --- | --- |
| Too many ideas compete in six seconds | Keep one message and one motion idea. |
| Text is readable only while paused | Hold the resolved state longer. |
| A transparent overlay leaves visible debris | Review the first and final frames over real footage. |
| Motion is energetic but communicates nothing | Tie the movement to the meaning of the word, number, or chart. |
| The result needs narration and several scenes | Move to the custom video workflow. |
<CardGroup cols={2}>
<Card title="Find a starting visual" icon="grid-2" href="/catalog">
Browse titles, charts, lower thirds, overlays, transitions, and effects.
</Card>
<Card title="Choose another workflow" icon="route" href="/workflows">
Return to the source-and-outcome chooser.
</Card>
</CardGroup>
+30
View File
@@ -24,6 +24,17 @@ Tell the agent:
- where the energy should change;
- whether the video must loop.
## Approve the musical structure
Confirm:
- the exact section of the track;
- the important beats, drops, phrases, or energy changes;
- which media and lyrics are approved;
- the visual arc from opening to ending;
- whether the edit should loop;
- how long text must remain readable even when the rhythm is fast.
## Review the rhythm
Not every beat needs a cut. Use stronger changes for important musical moments and leave enough visual continuity to understand the material.
@@ -37,3 +48,22 @@ Check:
- the ending or loop point.
Beat markers in the [Studio timeline](/studio/timeline) help refine the cut.
## Common problems
| Problem | Better direction |
| --- | --- |
| Every beat causes a cut | Reserve larger changes for stronger musical moments. |
| The edit is rhythmic but hard to understand | Hold important images and text across several beats. |
| Lyrics drift from the vocal | Correct transcription and timing before visual polish. |
| The ending feels cut off | Choose a musical landing or design a deliberate loop. |
| Supplied media has no visual progression | Assign different material to the intro, build, peak, and ending. |
<CardGroup cols={2}>
<Card title="Refine timing in Studio" icon="timeline" href="/studio/timeline">
Use beat markers to adjust cuts, holds, and the ending.
</Card>
<Card title="Choose another workflow" icon="route" href="/workflows">
Return to the source-and-outcome chooser.
</Card>
</CardGroup>
+30
View File
@@ -22,6 +22,17 @@ Say who the video is for:
- contributors may need architecture and tradeoffs;
- a social audience needs one clear change and visible proof.
## Approve the angle
Confirm:
- the intended PR and target branch;
- whether the audience cares about user impact, architecture, or both;
- the release state: proposed, merged, released, or planned;
- the before-and-after behavior;
- breaking changes or migration work;
- the maximum level of code detail.
## Check the facts
Before export:
@@ -33,3 +44,22 @@ Before export:
- confirm issue, version, and product names.
Use [Studio Storyboard](/studio/storyboard) to review the explanation and [Source](/studio/source) when a code excerpt needs adjustment.
## Common problems
| Problem | Better direction |
| --- | --- |
| The video reads the PR description aloud | Build a story around the user or system change. |
| Refactoring becomes a product claim | Separate internal work from visible behavior. |
| Code appears too briefly to read | Show only the relevant lines and hold them longer. |
| The PR is not released yet | Say that clearly instead of presenting it as shipped. |
| The audience is mixed | Make separate user-facing and contributor-facing versions. |
<CardGroup cols={2}>
<Card title="Review in Studio" icon="palette" href="/studio">
Check the facts, sequence, code excerpts, timing, and final release language.
</Card>
<Card title="Choose another workflow" icon="route" href="/workflows">
Return to the source-and-outcome chooser.
</Card>
</CardGroup>
+32
View File
@@ -7,6 +7,8 @@ Use this workflow when the video should market or explain a product, company, ap
Give the agent the real URL when the site’s interface, language, or visual identity should appear in the result. You can also begin from a written brief or script when no site capture is needed.
Use a [faceless explainer](/guides/faceless-explainer) instead when there is no product to show and the visuals should be invented from an idea or text.
## Start the request
```text
@@ -17,6 +19,17 @@ how quickly they can share a first result, and end with “Try it free.”
The `/hyperframes` router selects the Product Launch Video workflow.
## Approve the direction
Before the build, confirm:
- the audience and single main promise;
- whether the real site should be captured;
- the most important product state or task to show;
- the intended format and length;
- claims, screens, and words that must be exact;
- the final action for the viewer.
## Decide what kind of product video you need
| Goal | Useful direction |
@@ -60,3 +73,22 @@ Use the [Storyboard](/studio/storyboard) to check the message and scene sequence
Use the [canvas](/studio/canvas) and [timeline](/studio/timeline) to refine the product screens, text, pacing, and transitions.
Before export, confirm that claims shown in the video are current and supported by the product.
## Common problems
| Problem | Better direction |
| --- | --- |
| The video lists every feature | Choose one audience, one promise, and two or three pieces of proof. |
| It looks like a scrolling screen recording | Reconstruct the useful interaction and use captures as evidence. |
| The opening is generic | Show the product or its result earlier. |
| The UI is too small to understand | Focus each scene on one product area and crop deliberately. |
| The brand feels copied incorrectly | Supply the correct fonts, colors, logo, and approved product states. |
<CardGroup cols={2}>
<Card title="Review in Studio" icon="palette" href="/studio">
Check the complete story, refine visible details, and export versions.
</Card>
<Card title="Choose another workflow" icon="route" href="/workflows">
Return to the source-and-outcome chooser.
</Card>
</CardGroup>
+96
View File
@@ -0,0 +1,96 @@
---
title: "Create an interactive presentation"
sidebarTitle: "Create an interactive presentation"
description: "Ask an agent to build a navigable HyperFrames deck with reveals, notes, branches, hotspots, and presenter mode."
---
A HyperFrames slideshow is a running presentation, not a video pretending to be a deck.
It can contain discrete slides, progressive reveals, speaker notes, optional branches, clickable hotspots, presenter controls, and an audience view.
<Warning>
Choose this workflow only when the final result should remain interactive. A HyperFrames slideshow is presented with `hyperframes present`; rendering it as one linear MP4 is not currently a supported slideshow output.
</Warning>
## Use it when
- a presenter needs to control the pace;
- points should reveal one at a time;
- the audience may choose a branch or detail path;
- speaker notes and a separate audience view matter;
- an existing interactive page should become a navigable deck.
Use a normal video workflow when the result should play from beginning to end without a presenter.
## Give the agent
- the source notes, document, page, or existing deck;
- the audience and purpose;
- the rough number of slides;
- the main narrative;
- required brand or visual references;
- whether you need fragments, branches, hotspots, media, or speaker notes;
- the environment where it will be presented.
```text
/hyperframes Build a ten-slide interactive product briefing from these
notes. It is for a sales team introducing the product to design leaders.
Use progressive reveals, include speaker notes, and add a final branch
where the presenter can open either the roadmap or pricing detail.
```
## What the agent should confirm
Before building, agree on:
1. **Deliverable:** an interactive slideshow rather than a rendered video.
2. **Audience and decision:** what should change after the presentation?
3. **Main line:** the sequence every audience sees.
4. **Branches:** optional detail that should not interrupt the main story.
5. **Interaction:** reveals, hotspots, media, and presenter control.
6. **Handoff:** how and where the deck will be presented.
## Review the first version
Check the deck as a presenter, not as a passive video:
- Does each slide make one clear point?
- Do reveals help the explanation, or merely delay content?
- Can the main line stand without opening a branch?
- Are hotspots obvious enough to use but quiet enough not to distract?
- Do speaker notes help the presenter rather than repeat the slide?
- Does embedded media stop when you leave its slide?
- Can the audience view be shared without exposing presenter notes?
Use [Studio's Slideshow panel](/studio/slideshows) to review and adjust slide metadata.
## Present the deck
Run:
```bash
npx hyperframes present <project-directory>
```
Open the local URL, then click **Present** or press **P**. HyperFrames opens a separate audience view while the original tab becomes the presenter view with the current slide, next-slide preview, notes, and timer.
For a call:
- In Google Meet, share the audience **tab**.
- In Zoom, move the audience tab into its own window and share that window.
- Keep presenter notes on your own screen.
## Supported output
The primary output is the live, navigable deck. You can also create per-slide snapshots.
If the final deliverable must be a linear MP4 today, ask the agent to make a normal HyperFrames video from the same source rather than sending the slideshow to the video renderer.
## If something goes wrong
- If navigation does nothing, confirm the slideshow project is being served with `hyperframes present`.
- If a branch cannot be opened, ask the agent to check the hotspot target and slide sequence.
- If a reveal lands at the wrong moment, identify the slide and reveal number.
- If the audience view does not play media, interact with the audience tab once so the browser can allow playback.
[Start from a visible symptom →](/help)
+150
View File
@@ -0,0 +1,150 @@
---
title: "Get unstuck"
sidebarTitle: "Get unstuck"
description: "Start with what you can see, try the smallest useful fix, and return to your HyperFrames task."
---
Choose the symptom that looks most like yours. You should not need to read the entire documentation site or understand the rendering architecture to solve a normal problem.
<CardGroup cols={2}>
<Card title="Studio will not open" icon="window" href="#studio-will-not-open">
The browser never opens, the page is unreachable, or the project does not load.
</Card>
<Card title="Preview is wrong or stale" icon="rotate" href="#preview-is-wrong-or-stale">
A saved change is missing, playback looks old, or the preview is blank.
</Card>
<Card title="I cannot select or edit something" icon="arrow-pointer" href="#i-cannot-select-or-edit-something">
Selection, canvas controls, timing, or an Inspector field is unavailable.
</Card>
<Card title="Media is missing or black" icon="photo-film" href="#media-is-missing-or-black">
An image, video, font, or audio file is absent or does not render correctly.
</Card>
<Card title="Animation is wrong" icon="wand-magic-sparkles" href="#animation-is-wrong">
Motion jumps, drifts, starts at the wrong time, or differs after seeking.
</Card>
<Card title="Render failed or differs from preview" icon="film" href="#render-failed-or-differs-from-preview">
Export stops, produces the wrong result, or disagrees with Studio.
</Card>
<Card title="I have an error message" icon="triangle-exclamation" href="#copy-a-useful-diagnostic">
Preserve the exact message and collect enough context for an agent or issue.
</Card>
<Card title="I need a person" icon="life-ring" href="#ask-for-help">
Search known issues or report a reproducible problem.
</Card>
</CardGroup>
## Studio will not open
1. Open a terminal in the HyperFrames project folder.
2. Run `npx hyperframes preview`.
3. Keep that process running while Studio is open.
4. Use the local URL printed in the terminal.
If the command says it cannot find a project, confirm that the folder contains the HyperFrames project rather than its parent folder.
## Preview is wrong or stale
Try these in order:
1. Save the changed file.
2. Reload Studio once.
3. Check the terminal for a build or runtime error.
4. Run the project checks below.
```bash
npx hyperframes lint
npx hyperframes check
```
`lint` checks the composition structure. `check` opens the project in a browser gate and catches runtime, layout, motion, and contrast problems.
## I cannot select or edit something
- Open **Layers** and select the element there when clicking the canvas is difficult.
- Confirm that you are in **Preview**, not Storyboard.
- Scrub to a time where the element is visible.
- Check whether the visual lives inside a nested composition.
- Ask the agent when the change affects source structure rather than one visible element.
[Open Studio troubleshooting →](/studio/troubleshooting)
## Media is missing or black
Check:
- the file still exists inside the project;
- the path and filename capitalization match;
- the source is local and available during rendering;
- the browser can decode the media format;
- the media is visible at the current time;
- the terminal does not report a download, decode, or CORS error.
Do not rely on a temporary signed URL or a render-time network request. Ask the agent to copy required media into the project.
## Animation is wrong
First decide whether the problem happens:
- during normal playback;
- only after scrubbing;
- only in the final render.
That distinction helps separate a timeline mistake from non-deterministic animation. HyperFrames animation must be seekable: the same frame should look the same every time it is requested.
Run `npx hyperframes check`, then share the smallest affected scene and the exact timestamp with your agent.
## Render failed or differs from preview
1. Preserve the complete render error.
2. Run `npx hyperframes check`.
3. Confirm that fonts and media are local and load before capture.
4. Check the affected timestamp in Studio.
5. Try the normal MP4 preset before changing codecs or advanced flags.
Use the [complete troubleshooting guide](/guides/troubleshooting) for codec, browser, FFmpeg, GPU, HDR, and deployment-specific failures.
## Copy a useful diagnostic
Send this block to your agent and fill in the visible facts:
```text
What I was trying to do:
What I clicked or ran:
What I expected:
What happened instead:
Exact error:
Where it happens: Studio / lint / check / render
Does it happen every time?
HyperFrames version:
Operating system:
Affected file or timestamp:
```
Add a screenshot or short recording when the failure is visual. Do not paste access tokens, credentials, private media, or other secrets into a public issue.
## Ask for help
<CardGroup cols={2}>
<Card title="Common questions" icon="circle-question" href="/guides/common-questions">
Read short answers to the questions most likely to come up during first use.
</Card>
<Card title="Complete troubleshooting" icon="wrench" href="/guides/troubleshooting">
Diagnose less common project, media, animation, rendering, and environment failures.
</Card>
<Card title="Share product feedback" icon="comment" href="/guides/feedback">
Explain a confusing or broken experience with useful context.
</Card>
<Card title="Search GitHub issues" icon="github" href="https://github.com/heygen-com/hyperframes/issues">
Find known problems or open a reproducible issue.
</Card>
</CardGroup>
+90 -61
View File
@@ -1,84 +1,113 @@
---
title: "Welcome to HyperFrames"
description: "Make videos with an AI agent, refine them in Studio, and export the finished result."
title: "What is HyperFrames?"
sidebarTitle: "What HyperFrames is"
description: "See how an AI agent, a real project, and HyperFrames Studio work together to create a finished video."
---
HyperFrames is a way to create videos with an AI agent and still keep full control over the result.
HyperFrames lets an AI agent create a real video project, then gives you a visual Studio to review, edit, and export it.
Tell your agent what you want to make. It can plan the story, gather media, build the scenes, add motion, and open the project in **HyperFrames Studio**. In Studio, you can watch the video, rearrange timing, edit text and design, adjust animation, and export the finished file.
You can begin with an idea, website, script, pull request, recording, or music track. The agent handles the first build. You stay in control of the direction and the visible result.
You do not need to understand the rendering engine or write HTML to get started.
<Frame caption="A finished HyperFrames product video. This is the kind of result the agent and Studio produce together.">
<video
className="aspect-video w-full object-cover bg-zinc-100 dark:bg-zinc-900"
src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/hyperframes-launch-preview.mp4"
poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/hyperframes-launch-poster.jpg"
controls
muted
playsInline
preload="metadata"
/>
</Frame>
<CardGroup cols={2}>
<Card title="Try the browser Playground" icon="browser" href="https://www.hyperframes.dev/">
Explore and remix HyperFrames work without beginning in a local project.
<Card title="See how it works" icon="arrow-down" href="#from-request-to-finished-result">
Understand the complete loop without learning the technical architecture.
</Card>
<Card title="Make something with an agent" icon="sparkles" href="/quickstart">
Describe the outcome you want. Your agent chooses the right workflow and builds a first version.
</Card>
<Card title="Learn HyperFrames Studio" icon="palette" href="/studio">
See how to review, edit, animate, and export a project in the visual editor.
</Card>
<Card title="Browse reusable visuals" icon="grid-2" href="/catalog">
Find transitions, captions, charts, overlays, code animations, and complete scenes.
</Card>
<Card title="Build with the framework" icon="code" href="/developers">
Use the CLI, SDK, packages, schemas, and deployment tools.
<Card title="Make your first video" icon="sparkles" href="/quickstart">
Go from your own source material to a reviewable result in Studio.
</Card>
</CardGroup>
## What can you make?
## From request to finished result
HyperFrames is useful for more than one kind of video.
<CardGroup cols={2}>
<Card title="Product and website videos" icon="rocket">
Turn a product, website, or launch brief into a polished promo, tour, or social video.
</Card>
<Card title="Explainers" icon="lightbulb">
Turn notes, an article, or a difficult idea into a visual story with narration and motion.
</Card>
<Card title="Captions and video overlays" icon="closed-captioning">
Add subtitles, kinetic titles, lower thirds, quotes, and information cards to existing footage.
</Card>
<Card title="Motion graphics" icon="wand-magic-sparkles">
Create title sequences, animated statistics, charts, logo stings, and transparent overlays.
</Card>
<Card title="Music-driven videos" icon="music">
Cut images, footage, lyrics, and motion to the beat of a music track.
</Card>
<Card title="Interactive slideshows" icon="display">
Build presentations with reveals, speaker notes, branches, and clickable hotspots.
</Card>
</CardGroup>
## How the pieces fit together
```mermaid
flowchart LR
A["Your idea or source"] --> B["AI agent"]
B --> C["HyperFrames project"]
C --> D["Studio review and edits"]
D --> E["Finished video or presentation"]
```
<Steps>
<Step title="You describe the result">
Give an agent a product link, a script, a piece of footage, a pull request, a song, or a plain-language idea.
<Step title="Describe the result">
Tell the agent what you want the viewer to understand, feel, or do. Attach a website, text, footage, code change, music, or other source when you have one.
</Step>
<Step title="The agent builds a project">
The agent chooses the matching HyperFrames workflow, confirms the important creative choices, and creates the scenes and media.
<Step title="Approve the direction">
The agent confirms the important creative choices before spending time on the build.
</Step>
<Step title="You review it in Studio">
Play the result, leave direction, edit visible elements, change timing, adjust animation, and check the final frame.
<Step title="Review a real project">
The first version opens in HyperFrames Studio. It is not a flattened mystery file: the scenes, timing, media, text, and animation remain editable.
</Step>
<Step title="You export or share it">
Render a standard video, a transparent overlay, a high-resolution file, or a shareable published project.
<Step title="Improve what you can see">
Make direct changes in Studio or ask the agent for a broader revision.
</Step>
<Step title="Export the result">
Render a normal video, a transparent overlay, a high-resolution file, or keep the work as a navigable presentation.
</Step>
</Steps>
<Note>
HyperFrames projects are stored as normal files rather than a locked proprietary project format. That matters to agents and developers, but you can use the visual Studio without working directly with those files.
</Note>
## What can it make?
## Choose the shortest path
<CardGroup cols={2}>
<Card title="Product and website videos" icon="rocket" href="/guides/product-launch-video">
Launch videos, tours, promos, and showcases using the real product interface.
</Card>
<Card title="Visual explainers" icon="lightbulb" href="/guides/faceless-explainer">
Turn notes, articles, and difficult ideas into clear visual stories.
</Card>
<Card title="Captions and designed recuts" icon="closed-captioning" href="/guides/captions-and-recuts">
Add subtitles, titles, lower thirds, quotes, and information overlays to footage.
</Card>
<Card title="Motion graphics" icon="wand-magic-sparkles" href="/guides/motion-graphics">
Create animated titles, statistics, charts, logo stings, and transparent overlays.
</Card>
<Card title="Music-driven videos" icon="music" href="/guides/music-to-video">
Cut footage, images, lyrics, and motion to the structure of a music track.
</Card>
<Card title="Interactive presentations" icon="display" href="/workflows#a-presentation">
Build decks with reveals, notes, branches, presenter mode, and clickable navigation.
</Card>
</CardGroup>
- If you have an idea or source material, start with [Make your first video](/quickstart).
- If you want to explore first, open the [browser Playground](https://www.hyperframes.dev/).
- If an agent already created a project for you, open [Studio](/studio).
- If you want a ready-made visual, browse the [Catalog](/catalog).
- If you are integrating HyperFrames into another product, go to [Developers](/developers).
[Watch more finished work →](/examples)
Not sure which one fits? [Choose your path](/guides/choose-your-path) gives you a simple decision guide.
## What the person controls
HyperFrames is built so an agent can do the source-heavy work without hiding the result from you.
| Use Studio when… | Ask the agent when… |
| --- | --- |
| You can point at the exact text or visual. | The story or message needs to change. |
| A clip needs to move, trim, or split. | Several scenes need coordinated changes. |
| Color, size, position, or timing needs a direct adjustment. | New media, research, narration, or source work is required. |
| You want to compare and export versions. | You know the outcome but not the implementation. |
You do not need to understand HTML, packages, schemas, or the rendering engine to create and review a video. Those details remain available in [Developers](/developers) when somebody is integrating or extending the framework.
## Choose your next step
<CardGroup cols={2}>
<Card title="Try it in the browser" icon="browser" href="https://www.hyperframes.dev/">
Explore the Playground without beginning in a local project.
</Card>
<Card title="Make your first video" icon="play" href="/quickstart">
Follow the shortest complete path from source material to export.
</Card>
<Card title="Choose a workflow" icon="route" href="/workflows">
Find the correct path for a product, idea, recording, PR, motion graphic, song, or presentation.
</Card>
<Card title="Open an existing project" icon="palette" href="/studio">
Learn how to review, edit, and export work that an agent or teammate already created.
</Card>
</CardGroup>
+128 -117
View File
@@ -1,139 +1,150 @@
---
title: "Make your first video"
description: "Ask an AI agent to create a HyperFrames project, review it in Studio, and export the result."
description: "Go from your own source material to a reviewable HyperFrames video in Studio, then export it."
---
The simplest way to start is to tell an AI coding agent what you want to make. HyperFrames gives the agent the product knowledge and workflows it needs; Studio gives you a visual place to review and improve the result.
The goal of this guide is not to finish installation. It is to reach a first video you can watch, improve, and export.
## Before you start
**You need:** an AI coding agent, Node.js, and a folder where the agent can create the project. Most first projects take a few minutes to set up, plus the time needed to plan and build the actual video.
You need:
```mermaid
flowchart LR
A["Choose your source"] --> B["Send a useful request"]
B --> C["Approve the brief"]
C --> D["Review in Studio"]
D --> E["Export"]
```
- an AI coding agent such as Claude Code, Cursor, Codex, Gemini CLI, or GitHub Copilot CLI;
- Node.js installed on your computer;
- a folder where the agent can create the project.
## 1. Choose what you are starting with
You do **not** need to design the timeline or write a technical specification before you begin.
## Create the first version
<Steps>
<Step title="Install the HyperFrames skills">
Run this in your project folder:
```bash
npx hyperframes skills update
```
This installs the core guidance. The `/hyperframes` router adds a specialized workflow later when your request needs one.
</Step>
<Step title="Describe what you want">
Start your request with `/hyperframes`, then explain the result in normal language.
Use the closest example. You can change its wording before sending it.
<AccordionGroup>
<Accordion title="A product or website" icon="globe">
```text
/hyperframes Make a 30-second launch video for https://example.com.
It should feel calm and premium, use the product's real interface,
and end with “Start creating today.”
It is for small design teams. Show the real product interface, focus on
how quickly a team can share a result, and end with “Try it together.”
Keep the pacing calm and premium.
```
A useful request usually includes:
- the subject or source;
- who the video is for;
- the rough length and format, if they matter;
- the feeling you want;
- anything that must appear or must not appear.
If something important is missing, the agent will ask. You do not need to know which HyperFrames workflow to choose.
</Step>
<Step title="Approve the direction">
For a new project, the agent confirms the important creative choices before building. Read this like a short creative brief:
- Is the main message right?
- Does the proposed style fit?
- Is the length realistic?
- Are the required words, visuals, and call to action included?
Fix the direction here if needed. It is faster than rebuilding a finished video around the wrong idea.
</Step>
<Step title="Review the result in Studio">
The agent starts HyperFrames Studio and gives you a local project link. You can then:
- play the full video;
- inspect the storyboard;
- move and trim clips on the timeline;
- select text and visual elements on the canvas;
- adjust design and animation;
- ask the agent for broader changes.
See the [Studio tour](/studio/tour) when you want to understand the workspace.
</Step>
<Step title="Ask for changes">
Give feedback using the result you can see:
</Accordion>
<Accordion title="Notes, a script, or an idea" icon="lightbulb">
```text
Make the opening faster and reveal the product by three seconds.
Keep the current colors. Replace the final line with “Try it free.”
/hyperframes Turn these notes into a 45-second visual explainer for a
non-technical audience. The viewer should understand the three stages
and why the second one matters. Use diagrams and typography rather than
stock footage.
```
</Accordion>
<Accordion title="Existing footage" icon="video">
```text
/hyperframes Add clean word-level captions to this interview clip.
Keep the footage and audio unchanged. Use high contrast and emphasize
only the most important phrase in each sentence.
```
</Accordion>
<Accordion title="A pull request" icon="code-pull-request">
```text
/hyperframes Turn https://github.com/example/repo/pull/123 into a
45-second feature reveal. Lead with the user impact, then explain the
two most important implementation decisions.
```
</Accordion>
<Accordion title="A song or audio track" icon="music">
```text
/hyperframes Make a 30-second vertical promo driven by this music track.
Cut the attached images on the major beats and reserve the chorus for
the strongest product moment.
```
</Accordion>
</AccordionGroup>
Use Studio for direct visual adjustments. Use the agent when a change affects the story, several scenes, source files, or new media.
</Step>
<Step title="Export">
Open the **Renders** panel in Studio, choose the format and resolution, and start the export.
If none resembles your job, use the [workflow chooser](/workflows).
MP4 is the normal choice for a finished video. WebM or MOV may be more useful for transparent overlays or another editing workflow.
</Step>
</Steps>
## 2. Install the HyperFrames guidance
## Pick a request that matches your material
Open the project folder in your agent and run:
```bash
npx hyperframes skills update
```
This installs the core HyperFrames guidance. The `/hyperframes` router adds a specialized creation workflow when the request needs one.
<Note>
Start a fresh agent session if `/hyperframes` is not recognized after installation.
</Note>
## 3. Send the request
Paste the request you chose, attach or link the real source material, and add anything that must be accurate.
A useful first request answers:
- What should exist when the work is finished?
- Who will watch it?
- What source should the agent use?
- What format, duration, or tone matters?
- What must appear, and what must not?
Do not write a technical animation specification unless a particular motion is essential. The agent should solve the communication problem first.
## 4. Approve the creative direction
Before building a fresh project, the agent confirms the important choices. Read the response like a short creative brief:
- Is the main message correct?
- Does the audience match?
- Is the proposed format and length useful?
- Does the visual direction fit?
- Are exact claims, words, screens, and exclusions captured?
Correct misunderstandings here. Changing the direction before the build is faster than rebuilding a finished video around the wrong idea.
## 5. Review the first version in Studio
The agent starts Studio and gives you a local project link. Watch the complete video once before editing individual moments.
<Frame caption="Studio opens the real project so you can review the sequence, select visible elements, change timing, and export versions.">
<img src="/images/studio/overview.jpg" alt="HyperFrames Studio showing the video canvas, editing panels, and timeline" />
</Frame>
Check:
1. Can a new viewer understand the opening?
2. Is the main promise or idea accurate?
3. Does every scene earn its time?
4. Can text be read before it leaves?
5. Does the ending give the viewer somewhere to land?
Use Studio for a direct, visible change. Ask the agent when the change affects the story, multiple scenes, source files, or new media.
```text
Make the opening faster and reveal the product by three seconds.
Keep the current colors. Replace the final line with “Try it free.”
```
[Take the Studio tour →](/studio/tour)
## 6. Export the result
Open **Renders**, choose the format and resolution, and start the export.
- Choose **MP4** for a normal finished video.
- Choose **WebM** or **MOV** when another workflow needs transparency or a specific codec.
- Watch the exported file once, including the final frame and audio ending.
[See every export option →](/studio/export)
## You are done when…
You have a video that plays in Studio or an exported file you can watch. Installation alone is not the finish line.
<CardGroup cols={2}>
<Card title="A product or website" icon="globe" href="/guides/create-with-agent">
Share the URL and explain what the video should help the audience understand or do.
<Card title="Choose another workflow" icon="route" href="/workflows">
Make a product video, explainer, recut, PR video, motion graphic, music video, or presentation.
</Card>
<Card title="Notes or an idea" icon="lightbulb" href="/guides/create-with-agent">
Ask for an explainer when there is no website or existing footage to show.
</Card>
<Card title="Existing footage" icon="video" href="/guides/create-with-agent">
Ask for captions or designed overlays, and say whether the underlying footage should remain untouched.
</Card>
<Card title="A song or audio track" icon="music" href="/guides/create-with-agent">
Say that the music should drive the pacing and attach the media you want cut to the beat.
</Card>
</CardGroup>
## If you prefer to start manually
<Accordion title="Create and open a blank project">
Create a project:
```bash
npx hyperframes init my-video
cd my-video
```
Open it in Studio:
```bash
npx hyperframes preview
```
HyperFrames projects use HTML files, but you can make many changes visually in Studio or hand the folder to an agent at any point.
</Accordion>
## If something goes wrong
- If the agent does not recognize `/hyperframes`, restart the agent session after installing the skills.
- If Studio does not open, run `npx hyperframes preview` inside the project folder.
- If a render fails, open [Troubleshooting](/guides/troubleshooting) and copy the error into your agent.
## Next
<CardGroup cols={2}>
<Card title="Choose your path" icon="route" href="/guides/choose-your-path">
See which workflow fits your source material and intended result.
</Card>
<Card title="Tour Studio" icon="palette" href="/studio/tour">
Learn what the storyboard, canvas, inspector, timeline, and render queue are for.
<Card title="Get unstuck" icon="life-ring" href="/help">
Start with the visible symptom when Studio, media, animation, or export is not behaving.
</Card>
</CardGroup>
+79 -37
View File
@@ -1,56 +1,93 @@
---
title: "HyperFrames Studio"
description: "Review, edit, animate, and export a HyperFrames project in the browser."
title: "Review and edit a project in Studio"
sidebarTitle: "Studio overview"
description: "Understand an existing HyperFrames project, make the right kind of change, and export a version."
---
HyperFrames Studio is the visual workspace that opens when you preview a project.
HyperFrames Studio is the visual workspace for a project that an agent or teammate has already created.
Use it to understand what an agent built, make direct changes, and export the finished result. The edits stay with the project, so the visual editor, source files, and final render are working on the same composition.
Use it to review the story, play the built result, make direct visual changes, ask the agent for broader revisions, and export finished versions. You do not need to understand the project's HTML architecture to start.
## Open Studio
<Frame caption="The Studio workspace: project navigation, canvas, Inspector, playback, and timeline remain connected to the same project files.">
<img src="/images/studio/overview.jpg" alt="HyperFrames Studio showing the canvas, Inspector, playback controls, and timeline" />
</Frame>
From a HyperFrames project folder, run:
## Open the project
From the HyperFrames project folder, run:
```bash
npx hyperframes preview
```
Your browser opens the project in Studio. Keep the terminal process running while you work.
Keep the terminal process running and open the local URL it prints.
## What you can do
## First, understand the two views
<CardGroup cols={2}>
<Card title="Review the storyboard" icon="table-cells-large" href="/studio/storyboard">
Check each planned frame, its direction, status, voiceover, and agent feedback.
<Card title="Storyboard: review the plan" icon="table-cells-large" href="/studio/storyboard">
Check the sequence, direction, status, narration, and agent feedback before focusing on individual pixels.
</Card>
<Card title="Edit on the canvas" icon="arrow-pointer" href="/studio/canvas">
Select, move, resize, rotate, crop, and style visible elements.
</Card>
<Card title="Change timing" icon="timeline" href="/studio/timeline">
Move, trim, split, align, and organize clips.
</Card>
<Card title="Edit animation" icon="wand-magic-sparkles" href="/studio/animation">
Work with keyframes, easing, motion paths, and recorded movement.
</Card>
<Card title="Add media and Catalog items" icon="photo-film" href="/studio/assets-and-blocks">
Import media, reuse project assets, and add Catalog items.
</Card>
<Card title="Export versions" icon="download" href="/studio/export">
Render MP4, WebM, or MOV files and manage the render queue.
<Card title="Preview: review the built result" icon="play" href="/studio/tour">
Play the video and work with the canvas, Inspector, timeline, Code, Assets, Catalog, Variables, and Renders.
</Card>
</CardGroup>
## Two ways to look at a project
They are two views of the same project. Switching views does not create a separate version.
Use **Storyboard** when you are reviewing the idea and the planned sequence.
## The safest review order
Use **Preview** when you are editing the built video: canvas, Inspector, timeline, Code, Comps, Assets, Catalog, Variables, and Renders.
<Steps>
<Step title="Review the storyboard">
Confirm that the sequence and intended message still make sense.
</Step>
<Step title="Watch the complete result once">
Resist fixing the first imperfect detail immediately. Notice where the story becomes unclear, slow, unreadable, or visually repetitive.
</Step>
<Step title="Choose one visible task">
Use the pages below for the specific change instead of learning every Studio control.
</Step>
<Step title="Run a quick check">
Resolve visible warnings or copy the generated message to your agent when the fix requires source work.
</Step>
<Step title="Export a named version">
Keep useful iterations rather than overwriting the only file you can compare.
</Step>
</Steps>
Switching views does not create a different project. It changes what you are focusing on.
## What do you want to change?
## Studio and your agent work together
<CardGroup cols={2}>
<Card title="Text, layout, or design" icon="pen-ruler" href="/studio/canvas">
Select, move, resize, rotate, crop, and style something you can see.
</Card>
<Card title="Timing or clip order" icon="timeline" href="/studio/timeline">
Move, trim, split, align, and organize clips.
</Card>
<Card title="Animation" icon="wand-magic-sparkles" href="/studio/animation">
Adjust keyframes, easing, motion paths, or recorded movement.
</Card>
<Card title="Media or a reusable visual" icon="photo-film" href="/studio/assets-and-blocks">
Import a file, reuse a project asset, or add something from the Catalog.
</Card>
<Card title="Captions or variables" icon="closed-captioning" href="/studio/captions">
Correct transcript timing and text, or update reusable project values.
</Card>
<Card title="Export a version" icon="download" href="/studio/export">
Choose a format and resolution, render, and review the output.
</Card>
</CardGroup>
Studio is best for direct, visible changes. The agent is best for changes that require broader reasoning or source work.
## Studio or agent?
```mermaid
flowchart TD
A["Can you point at the exact thing to change?"] -->|Yes| B["Start in Studio"]
A -->|No| C["Describe the desired outcome to the agent"]
B --> D{"Does the change affect several scenes or source files?"}
D -->|No| E["Make the direct edit"]
D -->|Yes| C
```
| Change | Good place to start |
| --- | --- |
@@ -58,13 +95,18 @@ Studio is best for direct, visible changes. The agent is best for changes that r
| Trim a clip or split it at the playhead | Studio |
| Make the opening explain the product sooner | Agent |
| Add a completely new scene with new media | Agent |
| Fix a lint issue you do not understand | Copy it to the agent from Studio |
| Export a vertical and landscape version | Studio or agent, depending on whether the layout must change |
| Fix a warning you do not understand | Copy it to the agent from Studio |
| Export another resolution of the same layout | Studio |
| Redesign the layout for another aspect ratio | Agent, then review in Studio |
<Tip>
If you can point at the thing you want to change, try Studio. If you need to describe a new outcome, ask the agent.
</Tip>
## Finish safely
## Start with a five-minute tour
Before sharing:
Open [Tour the workspace](/studio/tour), then keep the relevant task page nearby while you edit.
1. Play the entire project from the beginning.
2. Check the final frame and audio ending.
3. Run the available lint or project check.
4. Export a version with a useful name.
5. Watch the exported file once.
If something blocks the task, [start from the visible symptom](/help).
+187
View File
@@ -0,0 +1,187 @@
---
title: "Choose a creation workflow"
sidebarTitle: "Choose a workflow"
description: "Start with what you have and what you want to make. HyperFrames will route your agent to the right workflow."
---
You do not need to learn HyperFrames' internal workflow names. Find the situation that resembles yours, copy a useful request, and let the agent confirm the creative direction before it builds.
<Tip>
If this is your first HyperFrames project, follow [Make your first video](/quickstart). This page is the faster route when you already know what HyperFrames is.
</Tip>
## Start with what you have
<CardGroup cols={2}>
<Card title="A product, website, or launch brief" icon="rocket" href="#product-or-website">
Make a launch video, product tour, promo, or showcase using the real product.
</Card>
<Card title="Notes, an article, or an idea" icon="lightbulb" href="#text-notes-or-an-idea">
Explain something without relying on a website or existing footage.
</Card>
<Card title="Existing talking-head footage" icon="video" href="#existing-footage">
Add readable captions or designed graphic overlays without changing the underlying clip.
</Card>
<Card title="A pull request" icon="code-pull-request" href="#a-pull-request">
Turn a code change into a concise feature reveal, fix explanation, or changelog video.
</Card>
<Card title="A short motion-first idea" icon="wand-magic-sparkles" href="#a-short-motion-graphic">
Animate a title, statistic, chart, logo sting, callout, or transparent overlay.
</Card>
<Card title="A music track" icon="music" href="#a-music-track">
Let the beat drive a lyric video, visualizer, slideshow, or promo.
</Card>
<Card title="A presentation" icon="display" href="#a-presentation">
Build a navigable deck with reveals, notes, branches, and hotspots.
</Card>
<Card title="Something custom" icon="shapes" href="#something-custom">
Plan a longer video, montage, title card, loop, or composition that does not fit the focused paths.
</Card>
</CardGroup>
## Product or website
**Best for:** launch videos, product tours, promos, and site showcases that should use the product's real interface.
**Give the agent:** a public URL or launch brief, the audience, the main promise, and any claims or screens that must appear.
```text
/hyperframes Make a 45-second launch video for https://example.com.
It is for small design teams. Show the real interface, focus on how quickly
a team can go from an idea to a shared result, and end with “Try it together.”
Keep the pacing confident rather than frantic.
```
[See the product and website workflow →](/guides/product-launch-video)
## Text, notes, or an idea
**Best for:** explainers where every visual should be invented from the subject rather than captured from a product site.
**Give the agent:** the source text, who needs to understand it, the desired takeaway, and the maximum length.
```text
/hyperframes Turn these notes into a 60-second visual explainer for a
non-technical audience. The viewer should understand the three stages and
why the second one prevents mistakes. Use diagrams and typography rather
than stock footage.
```
[See the explainer workflow →](/guides/faceless-explainer)
## Existing footage
Choose based on what must happen to the clip:
| Desired result | Best route |
| --- | --- |
| Plain or expressive subtitles; footage otherwise untouched | Embedded captions |
| Titles, quotes, lower thirds, data callouts, or side panels over untouched footage | Talking-head recut |
| Remove pauses, reorder speech, replace shots, or change the underlying edit | Custom video |
```text
/hyperframes Add clean word-level captions to this interview clip. Keep the
footage and audio unchanged. Use high contrast and emphasize only the most
important phrase in each sentence.
```
[Choose captions or a designed recut →](/guides/captions-and-recuts)
## A pull request
**Best for:** a feature reveal, fix explanation, refactor summary, or team changelog based on a GitHub PR.
**Give the agent:** the PR link, intended audience, desired tone, and whether the video should emphasize user impact or implementation.
```text
/hyperframes Turn https://github.com/example/repo/pull/123 into a concise
feature reveal for product engineers. Lead with what changed for users,
then show the two most important code decisions. Keep it under 60 seconds.
```
[See the PR-to-video workflow →](/guides/pr-to-video)
## A short motion graphic
**Best for:** motion-is-the-message pieces, usually under ten seconds, with no narration.
**Give the agent:** the exact text or data, dimensions, duration, visual tone, and whether the background must be transparent.
```text
/hyperframes Create a six-second vertical motion graphic announcing
“10 million renders.” Count up to the number, then reveal the label.
Use bold editorial type and export with a transparent background.
```
[See the motion graphics workflow →](/guides/motion-graphics)
## A music track
**Best for:** lyric videos, beat-synced slideshows, visualizers, and promos where music determines pacing.
**Give the agent:** the audio file, any lyrics, the media to use, and the intended format.
```text
/hyperframes Make a 30-second vertical promo driven by this music track.
Cut the attached product stills on the major beats, reserve the chorus for
the strongest image, and end on the supplied logo.
```
[See the music-to-video workflow →](/guides/music-to-video)
## A presentation
**Best for:** discrete slides with fragment reveals, speaker notes, branching, presenter mode, or clickable navigation.
Ask for a **slideshow** explicitly so the result remains a navigable deck rather than becoming a rendered linear video.
```text
/hyperframes Build a ten-slide interactive product briefing from these
notes. Use progressive reveals, add speaker notes, and include a final
branch where the presenter can open either the roadmap or pricing detail.
```
[See the slideshow workflow →](/guides/slideshow)
## Something custom
Use the general video path for longer or unusual work: multi-scene montages, title cards, static loops, mixed media, custom compositions, or projects where you want to co-create the structure with the agent.
[Plan a custom video →](/guides/general-video)
## What happens after you choose
<Steps>
<Step title="Install the HyperFrames guidance once">
In the project folder, run:
```bash
npx hyperframes skills update
```
Start a fresh agent session if the `/hyperframes` command is not recognized.
</Step>
<Step title="Send the request and source material">
Begin with `/hyperframes`. Include the desired result, audience, source, tone, constraints, and anything that must be accurate.
</Step>
<Step title="Approve the direction">
Check the message, format, length, visual approach, and required content before the agent builds.
</Step>
<Step title="Review the first version">
Watch the complete result once. Make direct visible edits in [Studio](/studio); ask the agent for changes that affect the story, several scenes, or new media.
</Step>
<Step title="Export or continue improving">
Use Studio's **Renders** panel when the result is ready. If something blocks you, start from the symptom in [Get unstuck](/help).
</Step>
</Steps>
## A useful request has six parts
1. **Outcome:** what should exist when the work is done?
2. **Audience:** who will watch it?
3. **Source:** URL, file, text, PR, audio, or idea.
4. **Format:** landscape, vertical, square, transparent overlay, or presentation.
5. **Tone:** a few precise words or a useful reference.
6. **Constraints:** exact claims, words, visuals, duration, or exclusions.
You can refine the request with [Give your agent a useful brief](/guides/prompting).
+41 -32
View File
@@ -150,29 +150,29 @@
</head>
<body>
<main>
<div class="eyebrow">Documentation refactor · after state</div>
<h1>A product guide, not a repository dump.</h1>
<div class="eyebrow">Documentation refactor · journey-led state</div>
<h1>Five clear ways into HyperFrames.</h1>
<p class="lede">
HyperFrames documentation now starts with human tasks, gives Studio its own complete manual,
keeps reusable visuals in Catalog, and moves implementation detail into Developers.
The documentation now begins with the situation a person is in: understand the product, make
a first video, choose a workflow, edit a project, or recover from a problem.
</p>
<div class="grid">
<div class="card">
<div class="metric">253</div>
<div class="metric">250</div>
<div class="label">navigated pages</div>
</div>
<div class="card">
<div class="metric">0</div>
<div class="label">orphan pages</div>
<div class="metric">5</div>
<div class="label">canonical P0 journeys</div>
</div>
<div class="card">
<div class="metric">4</div>
<div class="label">top-level tabs</div>
</div>
<div class="card">
<div class="metric">4</div>
<div class="label">real Studio visuals</div>
<div class="metric">3</div>
<div class="label">old routes redirected</div>
</div>
</div>
@@ -180,41 +180,42 @@
<h2>What changed</h2>
<div class="rows">
<div class="row">
<strong>Guides</strong>
<strong>Understand</strong>
<span
>Outcome-first onboarding, workflow selection, media, export, help, and updates.</span
>One sendable explanation with a finished video, product loop, examples, and a clear
next step.</span
>
<span class="status">Complete</span>
</div>
<div class="row">
<strong>First video</strong>
<span
>A material-first route from a useful request through creative approval, Studio
review, and export.</span
>
<span class="status">Complete</span>
</div>
<div class="row">
<strong>Workflows</strong>
<span
>An outcome-led chooser plus consistent product, explainer, PR, recut, motion, music,
slideshow, and custom-video guides.</span
>
<span class="status">Complete</span>
</div>
<div class="row">
<strong>Studio</strong>
<span
>Verified manual for Storyboard, canvas, layers, timeline, design, animation, assets,
source, lint, and export.</span
>A task-led route for understanding an existing project, making the right kind of
change, checking it, and exporting safely.</span
>
<span class="status">Complete</span>
</div>
<div class="row">
<strong>Catalog</strong>
<strong>Recovery</strong>
<span
>134 generated item pages with agent-first use, concise instructions, and folded
technical details.</span
>
<span class="status">Complete</span>
</div>
<div class="row">
<strong>Developers</strong>
<span
>CLI, SDK, packages, schemas, deployment, integrations, and contribution material
grouped together.</span
>
<span class="status">Complete</span>
</div>
<div class="row">
<strong>Header</strong>
<span
>Full-width Aspen navigation, logo, search, GitHub, theme toggle, and official
Playground action.</span
>A symptom-first help entrance with small fixes, useful diagnostics, detailed
troubleshooting, and human escalation.</span
>
<span class="status">Complete</span>
</div>
@@ -233,6 +234,14 @@
<li>Rigid internal pipeline guidance presented as a requirement for every user.</li>
<li>Duplicate Catalog titles and technical file tables dominating every item page.</li>
<li>Internal telemetry specifications presented as a normal feedback guide.</li>
<li>
Duplicate Overview, Choose your path, Create with an agent, and Help entrances competing
for the same jobs.
</li>
<li>
Machine-facing Claude Design and Open Design specifications cluttering the human
creation journey.
</li>
</ul>
</section>
@@ -0,0 +1,65 @@
# Journey implementation map
Status: **Approved and in implementation**
This map prevents individual page edits from drifting away from the approved end-to-end journeys.
## P0 journeys
| Journey | Canonical route | Entry promise | Primary supporting pages | Success state |
| ----------------------------------- | --------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| Understand HyperFrames from zero | `/introduction` | Understand the product in under a minute and see proof | Examples, Quickstart, Studio | Person can explain the agent → project → Studio → result loop and choose a next step |
| Make a first real video | `/quickstart` | Reach a reviewable result, not merely complete setup | Workflows, Prompting, Studio tour, Export | Video plays in Studio or an exported file exists |
| Start a specific creation workflow | `/workflows` | Choose by source and outcome without knowing internal skill names | Focused workflow pages, Prompting, Studio | Correct workflow starts with a sufficiently useful request |
| Review and edit an existing project | `/studio` | Understand the workspace, make the right type of change, and export | Storyboard, Tour, Canvas, Timeline, Animation, Export | Person makes a visible change or exports a version |
| Recover when something is wrong | `/help` | Start from the symptom and return to the interrupted task | Common questions, general troubleshooting, Studio troubleshooting, Feedback | Person fixes the problem or produces a useful diagnostic |
## Consolidation decisions
- `/guides/create-with-agent` is replaced by `/workflows`.
- `/guides/choose-your-path` is replaced by `/workflows`.
- `/guides/help` is replaced by `/help`.
- Old routes redirect so existing support messages and external links do not break.
- `/guides` remains a concise task router. It is not the canonical product explanation.
- `/introduction` remains the one link to send when somebody asks what HyperFrames is.
## Cross-link contract
Every P0 entry route must:
1. confirm the person's situation in the opening screen;
2. describe the result they will reach;
3. keep the main path visible before secondary detail;
4. link forward to the next task;
5. link to `/help` where the task can fail;
6. avoid requiring repository or framework architecture knowledge.
Supporting pages should return people to the journey they came from instead of ending in unrelated reference material.
## Visual contract
Available now:
- finished production video on Introduction;
- product-loop and task-progress diagrams;
- real Studio workspace imagery;
- Studio-versus-agent decision diagram;
- copyable requests based on realistic source material.
Production assets still required:
- 45–60 second “What is HyperFrames?” product-loop video;
- 75–90 second first-video walkthrough;
- 60–90 second real Studio tour;
- 6–12 second task loops for trim, split, text editing, keyframes, Catalog insertion, and export.
Until those assets are produced, existing real videos, screenshots, diagrams, and written equivalents must keep every journey complete.
## Removal rule
A page should be merged, hidden, or removed when it:
- duplicates a canonical entry route;
- supports no approved journey, real support question, or required reference;
- introduces internal terminology before the task requires it;
- ends without helping the person return to a task.
+25
View File
@@ -215,6 +215,31 @@ New navigation should be task-shaped:
- Created `USER-JOURNEYS-PROPOSAL.md` as an approval document. It defines seven journeys, recommends five as P0, assigns one canonical starting link to each, and specifies the sequence, success state, visual formats, current gaps, and validation method.
- Public docs should not be restructured again until the journeys are approved.
### 2026-07-29 — journey implementation approved
- The product owner approved the proposed journey model.
- Added `JOURNEY-IMPLEMENTATION-MAP.md` as the implementation contract.
- Began consolidating the P0 entrances around `/introduction`, `/quickstart`, `/workflows`, `/studio`, and `/help`.
- The established Aspen header, sidebar behavior, right-side table of contents, borders, typography, GitHub control, and agent input treatment remain unchanged.
### 2026-07-29 — journey implementation pass
- Rebuilt the five P0 entrances:
- `/introduction` now provides immediate proof, the product loop, human-control guidance, and focused next steps;
- `/quickstart` now starts from source material and ends at a played or exported result;
- `/workflows` is the canonical outcome-led creation chooser with useful requests;
- `/studio` now follows the real review → direct edit or agent revision → check → export journey;
- `/help` now starts from visible symptoms and produces a fix or useful diagnostic.
- Removed the duplicate Choose your path, Create with an agent, and old Help pages. Added redirects for every old route.
- Added the missing human-facing slideshow workflow, including the current live-deck output and honest MP4 limitation.
- Standardized the seven existing creation workflow pages with direction approval, review guidance, common problems, and a return to Studio or the workflow chooser.
- Reworked Catalog around the visual job and Developers around the smallest technical surface.
- Removed large machine-facing Claude Design and Open Design authoring specifications from the human navigation while preserving their source URLs.
- Added `VISUAL-PRODUCTION-BRIEFS.md` for the three P0 videos and eight Studio task loops.
- Updated the visual current-state dashboard around the five approved journeys.
- Browser-reviewed Introduction, Quickstart, Workflows, Help, Studio, Catalog, and Developers in the local Mintlify preview.
- `mint validate`, `mint broken-links`, and `git diff --check` pass.
## Maintenance issue
- The repo instructions refer to `.agents/skills/hyperframes/SKILL.md`, but that repo-local path is absent in this checkout. The installed current router at `/Users/ularkimsanov/.agents/skills/hyperframes/SKILL.md` was used as the workflow source of truth for this pass.
+3 -1
View File
@@ -2,7 +2,7 @@
## Current approval gate
Do not begin another public information-architecture or editorial pass until leadership approves the primary user journeys in `USER-JOURNEYS-PROPOSAL.md`.
Approved by the product owner on 2026-07-29. Public implementation is now in progress.
The approved journeys become the source of truth for:
@@ -13,6 +13,8 @@ The approved journeys become the source of truth for:
- consolidation and removal decisions;
- analytics and usability tests.
The route-to-journey contract is maintained in `JOURNEY-IMPLEMENTATION-MAP.md`.
Status: implementation complete; post-release measurement remains
Started: 2026-07-28
Primary audience: people who want to make, edit, and share videos with HyperFrames
@@ -0,0 +1,137 @@
# Documentation visual production briefs
Status: **Ready for production**
The written journeys are complete without these assets. These videos and loops are the next improvement: they should reduce explanation time, not decorate pages.
## Shared rules
- Build the videos with HyperFrames so the documentation proves the product through its own output.
- Use real product states and honest claims.
- Every video must work muted.
- Include captions and a written equivalent.
- Avoid rapid UI montage that looks impressive but teaches nothing.
- Show the cursor only when its action matters.
- Keep interface text readable at the final embedded size.
- End on the next action the page asks the viewer to take.
## P0-A — What is HyperFrames?
**Placement:** `/introduction`, above the first major section
**Duration:** 45–60 seconds
**Job:** replace the five-minute verbal product explanation
### Story
1. A person starts with a plain-language request and real source.
2. The agent confirms the creative direction.
3. The agent builds a real HyperFrames project.
4. The project opens in Studio.
5. A person makes one visible direct edit.
6. The person asks the agent for one broader revision.
7. Studio exports the result.
8. The finished video plays.
### Required message
> An agent creates the first real project. A person reviews and edits it in Studio. HyperFrames exports the result.
### Avoid
- opening with HTML, packages, or rendering architecture;
- presenting Studio as a separate product;
- implying that every project begins from a website;
- showing only a finished montage without the creation loop.
## P0-B — Make your first video
**Placement:** `/quickstart`, after the opening outcome
**Duration:** 75–90 seconds
**Job:** show the shortest complete first-use path
### Story
Use one realistic product URL:
1. install the HyperFrames guidance;
2. send the request;
3. review the returned brief;
4. approve it;
5. show the build at a useful level without waiting through every operation;
6. open Studio;
7. watch the complete first version;
8. make one direct edit;
9. ask for one broader revision;
10. export MP4 and play the file.
### On-screen progress
`Request → Brief → Build → Review → Export`
### Avoid
- treating installation as the conclusion;
- using a fake example domain in the final recording;
- hiding the creative approval step;
- cutting before the exported file is visibly played.
## P0-C — Studio in 90 seconds
**Placement:** `/studio`, after the opening description
**Duration:** 60–90 seconds
**Job:** orient someone opening an agent-created project
### Story
1. Open an existing project.
2. Explain Storyboard versus Preview.
3. Play the complete result.
4. Select a visible element.
5. Change its text or design.
6. Adjust one clip on the timeline.
7. Show one animation control.
8. copy one broader feedback message to the agent;
9. run the project check;
10. export a named version.
### Required message
> If you can point at the thing, start in Studio. If you need a broader outcome, ask the agent.
## P1 task loops
Each loop should be 6–12 seconds, silent, captioned, and tightly cropped around one task.
| Loop | Placement | Visible success |
| ---------------------------- | ------------------ | ------------------------------------- |
| Select and edit text | Canvas | Updated text remains selected |
| Trim a clip | Timeline | New clip edge and changed playback |
| Split at the playhead | Timeline | Two clips appear |
| Add a keyframe | Animation | Diamond appears and movement previews |
| Add a Catalog item | Assets and Catalog | Item appears in the project |
| Fix caption timing | Captions | Words align with speech |
| Save and copy agent feedback | Storyboard | Useful message reaches clipboard |
| Export MP4 | Export | Finished file appears in the queue |
## Static diagrams
Already implemented in the docs:
- source → agent → project → Studio → result;
- first-video progress;
- Studio versus agent decision;
- developer surface chooser.
Before replacing a diagram with motion, test whether motion makes the relationship easier to understand. Keep the static version as the accessible text equivalent.
## Production approval
Before publishing each video, confirm:
- product controls and names match the current release;
- source material can be shown publicly;
- claims are supported;
- no private paths, tokens, account information, or notifications appear;
- captions match the final voice or on-screen text;
- the embedded poster makes sense before playback;
- the page still works when the video is unavailable.