Skip to content

Commit 14aa4d0

Browse files
committed
docs(start): the Studio app first, the browser editor named, a showcase wall that renders
1 parent 382a14d commit 14aa4d0

7 files changed

Lines changed: 133 additions & 114 deletions

File tree

‎docs/docs.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,8 +1129,8 @@
11291129
"href": "/product-updates"
11301130
},
11311131
{
1132-
"label": "Playground",
1133-
"href": "https://www.hyperframes.dev/"
1132+
"label": "Download the Studio app",
1133+
"href": "https://hyperframes.dev/studio/download?src=docs-footer"
11341134
},
11351135
{
11361136
"label": "GitHub",
@@ -1149,8 +1149,8 @@
11491149
],
11501150
"primary": {
11511151
"type": "button",
1152-
"label": "Playground",
1153-
"href": "https://www.hyperframes.dev/"
1152+
"label": "Download Studio",
1153+
"href": "https://hyperframes.dev/studio/download?src=docs-navbar"
11541154
}
11551155
},
11561156
"redirects": [

‎docs/go-further.mdx‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Go further with HyperFrames"
33
sidebarTitle: "Go further"
4-
description: "Take more control of an existing project through your agent, Studio, richer composition tools, and a reliable finish."
4+
description: "Take more control of an existing project through your agent, the Studio app or the browser editor, richer composition tools, and a reliable finish."
55
---
66

77
import { AdvancedPathGrid } from "/snippets/advanced-path-grid.jsx";
@@ -15,13 +15,14 @@ import { DocsVideo } from "/snippets/docs-video.jsx";
1515
/>
1616
</div>
1717

18-
The project does not change format as you gain control. Your agent, Studio, the
19-
SDK, the Player, and the renderer all work from the same HTML project.
18+
The project does not change format as you gain control. Your agent, the Studio app, the browser editor, the
19+
SDK, the Player, and the renderer all work from the same HTML project. Made it with your agent on a Mac?
20+
[Open it in the Studio app](/studio-app/existing-project) and keep going there.
2021

2122
## Choose by the size of the change
2223

23-
Use the agent for changes to the story or several scenes. Use Studio for the
24-
specific visual or timing detail you can point at.
24+
Use the agent for changes to the story or several scenes. Use the browser editor, or point at the picture in the
25+
Studio app, for the specific visual or timing detail you can see.
2526

2627
<AdvancedPathGrid />
2728

@@ -30,6 +31,6 @@ For reusable content and nested structure, continue with [Variables](/concepts/v
3031

3132
## Related topics
3233

33-
- [Edit the project visually in Studio](/studio)
34+
- [Edit the project by hand in the browser editor](/studio)
3435
- [Understand how a HyperFrames project works](/concepts)
3536
- [Build on HyperFrames as a developer](/developers)

‎docs/guides/choose-creation-path.mdx‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,45 @@
11
---
22
title: "Choose how to create"
33
sidebarTitle: "Choose how to create"
4-
description: "Four places to make a HyperFrames video, and how to tell which one is yours."
4+
description: "Five places to make a HyperFrames video, and how to tell which one is yours."
55
---
66

7-
There are four places to make a HyperFrames video. They all give you a video.
7+
There are five places to make a HyperFrames video. They all give you a video.
88
The difference is what you keep afterwards. Unsure? Take the first one.
99

1010
| Start here | You end up with |
1111
| --- | --- |
12+
| The Studio app (Mac, Linux) | A project you keep editing by chatting, pointing and drawing, your agent beside the preview |
1213
| A coding agent on your computer | A project folder you own and keep editing |
1314
| An AI chat | A video made and kept in your HeyGen account |
1415
| A design tool | A look to finish on your computer |
1516
| HeyGen Video Agent | A finished video, assembled for you |
1617

17-
## Start on your computer if the video will change
18+
## Start in the Studio app if you want to watch it change
19+
20+
The free app for Mac and Linux runs your own agent (Claude Code, Codex, GitHub Copilot, or OpenCode with free
21+
models) beside a live preview and a timeline. You change the video by typing, pointing at the picture or drawing on
22+
it, and each agent run has its own **Undo**. Windows is coming soon.
23+
24+
[Install the Studio app →](/studio-app)
25+
26+
## Start with your coding agent if you work in a terminal
1827

1928
A coding agent — an AI assistant that works in a folder on your machine, like
2029
Claude Code or Cursor — writes a plain HTML project. Revise it with the agent,
21-
open it in Studio, read the source, make the MP4 locally.
30+
open it in the browser editor, read the source, make the MP4 locally. This works on any system, Windows included.
2231

2332
```text
2433
Using /hyperframes, make a 10-second product intro for https://example.com.
2534
```
2635

27-
[Make your first local video →](/quickstart)
36+
[Make your first video with your agent →](/quickstart#with-your-agent)
2837

2938
## Start in an AI chat if you want nothing installed
3039

3140
The hosted HyperFrames connector (an MCP connector — a plug-in an AI chat can
3241
use) builds and renders through your HeyGen account. You give up the project
33-
folder, Studio, and local rendering.
42+
folder, the editors, and local rendering.
3443

3544
[Connect HyperFrames to an AI chat →](/guides/mcp)
3645

‎docs/quickstart.mdx‎

Lines changed: 73 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,57 @@
11
---
22
title: "Make your first video"
3-
description: "Install the HyperFrames skills, make one short request, and continue with your agent, Studio, or the CLI."
3+
description: "Make your first HyperFrames video in the free Studio app for Mac and Linux, with your own AI agent, or in an AI chat with nothing to install."
44
---
55

66
import { QuickstartContinuationGrid } from "/snippets/quickstart-continuation-grid.jsx";
77
import { DocsVideo } from "/snippets/docs-video.jsx";
88

9-
<div className="hf-docs-video-frame">
10-
<DocsVideo
11-
title="A beginner creates a first HyperFrames video from one short request, then continues with an agent, Studio, or the CLI."
12-
src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/journey-quickstart-v5-v2.mp4"
13-
poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/journey-quickstart-v5.jpg"
14-
/>
15-
</div>
9+
HyperFrames turns one sentence into a video you can keep editing. Start in the Studio app; if you are on Windows or
10+
already work with an AI agent in a terminal, use one of the other two ways. All three make the same kind of project.
11+
12+
<DocsVideo
13+
title="A first video in the Studio app: one request, a few questions, a storyboard, the finished film"
14+
src="https://static.heygen.ai/hyperframes-oss/docs/studio-demos/first-video-demo-v2.mp4"
15+
poster="/public/images/studio-app/first-video-demo-v2.jpg"
16+
aspect="16 / 10"
17+
autoPlay
18+
loop
19+
/>
1620

1721
<Note>
18-
HyperFrames is free and open-source, and local rendering does not use HeyGen credits. Your coding
19-
agent and any optional hosted, voice, avatar, or generated-media services may have their own
20-
costs.
22+
HyperFrames is free. Your AI agent bills its own plan, and HeyGen media such as avatars and generated clips uses
23+
HeyGen credits only when you ask for it.
2124
</Note>
2225

23-
## The short way: hand it to your agent
26+
## In the Studio app
27+
28+
The easiest way: the app runs your agent beside a live preview, and you change the video by typing, pointing or
29+
drawing. For Mac (Apple Silicon or Intel) and Linux; Windows is coming soon.
30+
31+
<Steps>
32+
<Step title="Download and install">
33+
<a href="https://hyperframes.dev/studio/download?src=docs-quickstart">Download the Studio app</a>, open it, and
34+
sign in with a free HeyGen account. [Install the Studio app](/studio-app) has the steps for each system.
35+
</Step>
36+
<Step title="Ask for the video">
37+
Type what you want in **Make something** and send it. Framey asks a few questions, shows a storyboard, then
38+
builds the film.
39+
</Step>
40+
<Step title="Change it">
41+
Ask for changes in the chat, or point at the picture. [Make your first video in the app](/studio-app/first-video)
42+
walks through it.
43+
</Step>
44+
</Steps>
45+
46+
## With your agent
2447

25-
If you already have a coding agent open in a folder, paste this and skip the
26-
rest of the page. It installs the skills, makes the video, and opens the
27-
preview — you only change the URL.
48+
For Claude Code, Codex, Cursor, Copilot, Gemini CLI or any agent that works in a folder on your computer, on any
49+
system.
50+
51+
### The short way
52+
53+
If you already have a coding agent open in a folder, paste this. It installs the skills, makes the video, and opens
54+
the preview. You only change the URL.
2855

2956
```text
3057
Set this folder up for HyperFrames and make me a video.
@@ -34,51 +61,49 @@ Set this folder up for HyperFrames and make me a video.
3461
3. Open the local preview when it is done and tell me the project folder.
3562
```
3663

37-
Swap `https://example.com` for the page you want the video to show. Everything
38-
below is the same thing done by hand, if you would rather see each step.
39-
40-
## 1. Install the plugin or skills
64+
### Step by step
4165

42-
For Claude Code, Copilot, VS Code, Cursor, or Gemini CLI, start with the
43-
[plugin installation guide](/guides/plugins). It includes update settings for
44-
each agent. Claude's plugin entry skill is `/hyperframes:hyperframes`.
66+
<Steps>
67+
<Step title="Install the plugin or skills">
68+
For Claude Code, Copilot, VS Code, Cursor, or Gemini CLI, start with the
69+
[plugin installation guide](/guides/plugins). It includes update settings for each agent. Claude's plugin entry
70+
skill is `/hyperframes:hyperframes`.
4571

46-
For standalone skills, run this in your project folder:
72+
For standalone skills, run this in your project folder, choose **Core Skills** in the picker, then open or
73+
restart your agent in that folder:
4774

48-
```bash
49-
npx skills add heygen-com/hyperframes
50-
```
51-
52-
Choose **Core Skills** in the picker. Then open or restart your coding agent in that folder.
53-
54-
## 2. Ask for the video
55-
56-
```text
57-
Using /hyperframes, make a 10-second product intro for https://example.com.
58-
```
75+
```bash
76+
npx skills add heygen-com/hyperframes
77+
```
78+
</Step>
79+
<Step title="Ask for the video">
80+
```text
81+
Using /hyperframes, make a 10-second product intro for https://example.com.
82+
```
5983

60-
Replace `https://example.com` with the real page you want the video to show. The agent will propose
61-
a direction and ask for anything important that is missing. You do not need to write a production
62-
specification.
84+
Replace `https://example.com` with the page you want the video to show. The agent proposes a direction and asks
85+
for anything important that is missing.
86+
</Step>
87+
<Step title="Continue from the first version">
88+
The agent leaves you with a project folder and opens its preview in the browser editor. To reopen it later, run
89+
`npx hyperframes preview` in the project folder. All three paths below work on the same project.
6390

64-
## 3. Continue from the first version
91+
<QuickstartContinuationGrid />
92+
</Step>
93+
</Steps>
6594

66-
The agent leaves you with an editable project folder and opens its local preview.
67-
To reopen that preview later, run `npx hyperframes preview` inside the project
68-
folder. Watch the first version once and check the story, facts, readable text,
69-
and sound; it is not a guaranteed final cut. All three paths below work with
70-
the same project.
95+
## In an AI chat, nothing to install
7196

72-
<QuickstartContinuationGrid />
97+
In Claude.ai or ChatGPT, the HyperFrames connector builds and renders the video in your HeyGen account. You give up
98+
the project folder and local rendering. [Connect HyperFrames to an AI chat](/guides/mcp).
7399

74100
## Related topics
75101

76102
<CardGroup cols={2}>
77103
<Card title="Choose what to make" icon="route" href="/workflows">
78-
Product launch, explainer, captions, recut, pull request, music, motion graphic, or
79-
presentation.
104+
Product launch, explainer, captions, recut, pull request, music, motion graphic, or presentation.
80105
</Card>
81-
<Card title="Go further" icon="arrow-right" href="/go-further">
82-
Direct the agent, edit in Studio, build richer projects, and finish with confidence.
106+
<Card title="Continue from Claude Code in the app" icon="arrow-right" href="/studio-app/existing-project">
107+
Open a project your agent made in the Studio app, and hand it back.
83108
</Card>
84109
</CardGroup>

‎docs/snippets/advanced-path-grid.jsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ export const AdvancedPathGrid = () => {
1515
poster: "https://static.heygen.ai/hyperframes-oss/docs/images/showcase/go-further-agent-revision-loop-v1.jpg",
1616
},
1717
{
18-
title: "Edit in Studio",
18+
title: "Edit in the browser editor",
1919
detail: "Change visible design, text, media, timing, and animation in the live project.",
20-
action: "Open the Studio guide",
20+
action: "Open the browser editor guide",
2121
href: "/studio",
2222
video: `${CDN}/studio-direct-edit-loop-v2.mp4`,
2323
poster: `${CDN}/studio-direct-edit-loop-v2.jpg`,
@@ -33,7 +33,7 @@ export const AdvancedPathGrid = () => {
3333
{
3434
title: "Check, render, and share",
3535
detail:
36-
"Validate the project, render through Studio, an agent, or the CLI, and review the file.",
36+
"Validate the project, render through the browser editor, an agent, or the CLI, and review the file.",
3737
action: "Finish the project",
3838
href: "/guides/export-and-share",
3939
video: `${CDN}/studio-check-render-loop-v5.mp4`,

‎docs/snippets/docs-video.jsx‎

Lines changed: 29 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -401,46 +401,25 @@ export const DocsVideo = ({
401401
};
402402

403403
export const ShowcaseWall = () => {
404-
const CDN = "https://static.heygen.ai/hyperframes-oss/docs/images/showcase";
404+
// The same films as the homepage showcase (hyperframes.heygen.com), from the team and ours: a tile plays the 720p
405+
// card, an opened film the 1080p copy.
406+
const CDN = "https://static.heygen.ai/hyperframes-oss/homepage/showcase";
407+
const homepageFilm = (id, v, title, note, length) => ({
408+
id,
409+
title,
410+
note,
411+
length,
412+
tile: `${CDN}/card/${id}-v${v}.mp4`,
413+
full: `${CDN}/hq/${id}-v${v}.mp4`,
414+
poster: `${CDN}/poster/${id}-v${v}.jpg`,
415+
});
405416
const films = [
406-
{
407-
id: "grading",
408-
tile: "tile-grading-v2",
409-
full: "full-grading-4k-v2",
410-
title: "Colour grading and media effects",
411-
note: "Real footage graded with LUTs, curves, and scopes — inside Studio.",
412-
length: "48s",
413-
},
414-
{
415-
id: "variables",
416-
title: "One shoot, many cuts",
417-
note: "The same footage rendered as several vertical videos from one project.",
418-
length: "44s",
419-
},
420-
{
421-
id: "music",
422-
title: "Cut to the music",
423-
note: "A track analysed for beats and sections, then everything snapped to that grid.",
424-
length: "90s",
425-
},
426-
{
427-
id: "prvideo",
428-
title: "A pull request, explained",
429-
note: "A code change turned into a review anyone on the team can watch.",
430-
length: "32s",
431-
},
432-
{
433-
id: "timeline",
434-
title: "Editing on a timeline",
435-
note: "Trimming, splitting, and retiming a project by hand.",
436-
length: "34s",
437-
},
438-
{
439-
id: "hypecard",
440-
title: "A year in review",
441-
note: "Personal data turned into a shareable card, generated per person.",
442-
length: "27s",
443-
},
417+
homepageFilm("frameys-opening-night", 1, "Opening night", "Awards trailer", "50s"),
418+
homepageFilm("real-ui-newspaper-1969", 2, "Men walk on the Moon", "Real UI, rebuilt in code", "8s"),
419+
homepageFilm("manga-last-onigiri", 1, "The last onigiri", "Manga", "26s"),
420+
homepageFilm("vfx-background-removal-launch", 1, "Background removal", "VFX", "43s"),
421+
homepageFilm("cow", 1, "Cow 1.0", "Launch parody", "30s"),
422+
homepageFilm("remotion-to-hyperframes", 1, "Remotion to HyperFrames", "3D voxel", "20s"),
444423
];
445424
const [openId, setOpenId] = useState(null);
446425
// Lazy initializer, not a post-mount effect: with useState(false) the first
@@ -481,12 +460,17 @@ export const ShowcaseWall = () => {
481460
if (open) {
482461
return (
483462
<div style={{ margin: "1.5rem 0" }}>
484-
<DocsVideo
463+
{/* A plain video, not DocsVideo: a Mintlify snippet can't use another export of its file, and the reference
464+
alone stopped the whole wall from rendering. Opened by a click, so it may start with sound. */}
465+
<video
485466
key={open.id}
486-
title={open.title}
487-
src={`${CDN}/${open.full || `full-${open.id}`}.mp4`}
488-
poster={`${CDN}/${open.tile || `tile-${open.id}`}.jpg`}
467+
src={open.full}
468+
poster={open.poster}
469+
aria-label={open.title}
470+
controls
489471
autoPlay
472+
playsInline
473+
style={{ display: "block", width: "100%", borderRadius: "12px", background: "#000" }}
490474
/>
491475
<div
492476
style={{
@@ -553,8 +537,8 @@ export const ShowcaseWall = () => {
553537
}}
554538
>
555539
<video
556-
src={reduced ? undefined : `${CDN}/${film.tile || `tile-${film.id}`}.mp4`}
557-
poster={`${CDN}/${film.tile || `tile-${film.id}`}.jpg`}
540+
src={reduced ? undefined : film.tile}
541+
poster={film.poster}
558542
autoPlay={!reduced}
559543
muted
560544
loop={!reduced}

‎docs/snippets/quickstart-continuation-grid.jsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ export const QuickstartContinuationGrid = () => {
1212
instruction: "Make the title larger, then render another version.",
1313
},
1414
{
15-
title: "Open Studio",
16-
detail: "Point at the same project and make a visible edit.",
15+
title: "Open the browser editor",
16+
detail: "Edit the same project on a timeline, by hand.",
1717
instruction: "npx hyperframes preview",
1818
},
1919
{

0 commit comments

Comments
 (0)