Skip to content

Commit 0390f3f

Browse files
authored
docs(studio): the browser editor in six pages, named the browser editor (#6379)
* docs(studio): the browser editor in six pages, named the browser editor * docs(studio): mute where the editor has it, and no solo control The audio pages still described a solo control and a group-row mute that the editor does not render. Muting is the speaker button on an audio track (Mute track / Unmute track), the same toggle on a selected clip, and the Muted switch; a group is silenced through its members' tracks. The audio reference drops its solo section for the same reason.
1 parent afdad4e commit 0390f3f

56 files changed

Lines changed: 1098 additions & 1431 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/changelog.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5174,9 +5174,9 @@ what people hit first when they used it, and documents the whole system.
51745174

51755175
- **Audio:** The audio effects system is documented. There are new pages for
51765176
[mixing and presets](/studio/audio-effects), the [voiceover
5177-
carve](/studio/voiceover-carve), [groups, mute and
5178-
solo](/studio/audio-groups), and [automation
5179-
lanes](/studio/audio-automation), plus a [full
5177+
carve](/studio/audio-effects#make-music-sit-under-narration), [groups, mute and
5178+
solo](/studio/audio-effects#group-tracks), and [automation
5179+
lanes](/studio/audio-effects#automate-over-time), plus a [full
51805180
reference](/reference/audio-effects) covering every effect, parameter range,
51815181
preset, and attribute ([0eca7b1e0](https://github.com/heygen-com/hyperframes/commit/0eca7b1e0aef831bbab1265395f942378468afc0), [#3420](https://github.com/heygen-com/hyperframes/pull/3420)).
51825182

‎docs/concepts/compositions.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ And the source file both cards share:
245245
[Variables](/concepts/variables) covers the types, the bindings that need no
246246
script, CLI overrides, and which value wins. If you are building tooling on
247247
`@hyperframes/core`, `extractCompositionMetadata()` reads the same
248-
`data-composition-variables` array — that is how Studio builds its editing UI.
248+
`data-composition-variables` array — that is how the browser editor builds its editing UI.
249249

250250
## Load a composition's own files from its script
251251

‎docs/concepts/data-attributes.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ a start, a duration, and a track:
1717
| ------------------ | ------------------------------------------------ |
1818
| `data-start` | When the element enters the composition timeline |
1919
| `data-duration` | How long its timeline slot lasts |
20-
| `data-track-index` | Which Studio lane displays it (optional; the render ignores it) |
20+
| `data-track-index` | Which browser editor lane displays it (optional; the render ignores it) |
2121

2222
Add `class="clip"` to timed DOM and image elements. The runtime keys visibility
2323
off `data-start` rather than the class, but the shared `.clip` rule is what gives
@@ -26,11 +26,11 @@ audio has no visual lifecycle.
2626

2727
## Tracks are not layers
2828

29-
Tracks are the rows Studio draws. They do not decide which element is in front,
29+
Tracks are the rows the browser editor draws. They do not decide which element is in front,
3030
and they do not schedule anything. Use CSS `z-index` for paint order.
3131

3232
Two clips on one track may overlap; the render composites both. Separate tracks
33-
keep an intentional overlap, such as a crossfade, readable in Studio:
33+
keep an intentional overlap, such as a crossfade, readable in the browser editor:
3434

3535
```html
3636
<video

‎docs/concepts/index.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,34 @@ project.
1616
flowchart TD
1717
S["Your project folder<br/>HTML, CSS, media"]
1818
A["Agent<br/>story and structure"] <--> S
19-
T["Studio<br/>what you can point at"] <--> S
19+
T["Browser editor<br/>what you can point at"] <--> S
2020
C["CLI<br/>check, preview, render"] <--> S
2121
K["SDK and Player<br/>inside your own product"] <--> S
2222
S --> R["renders/final.mp4"]
2323
```
2424

2525
## The source is the project
2626

27-
The agent, Studio, CLI, SDK, and Player do not create separate versions of the
27+
The agent, the browser editor, CLI, SDK, and Player do not create separate versions of the
2828
video. They work with the same project files.
2929

3030
| What you want to change | Best place to start |
3131
| ---------------------------------------------------- | ------------------- |
3232
| Story, structure, or several scenes | Ask the agent |
33-
| Text, layout, timing, or animation you can see | Studio |
33+
| Text, layout, timing, or animation you can see | The browser editor |
3434
| Preview, checks, snapshots, rendering, or automation | CLI |
3535
| A composition inside your own product | SDK or Player |
3636

3737
<div style={{ maxWidth: "42rem", margin: "1.5rem auto" }}>
38-
<Frame caption="The same editable project open in Studio, with its source, canvas, controls, and timeline.">
38+
<Frame caption="The same editable project open in the browser editor, with its source, canvas, controls, and timeline.">
3939
<img
4040
src="https://static.heygen.ai/hyperframes-oss/docs/images/studio/overview-v1.jpg"
41-
alt="A HyperFrames project open in Studio with the source tree, canvas, controls, and timeline"
41+
alt="A HyperFrames project open in the browser editor with the source tree, canvas, controls, and timeline"
4242
/>
4343
</Frame>
4444
</div>
4545

46-
Studio writes supported edits back into the source. An agent can continue from
46+
The browser editor writes supported edits back into the source. An agent can continue from
4747
those files, Git can track them, and the renderer sees the same result.
4848

4949
## What the agent creates
@@ -116,7 +116,7 @@ Timed elements carry their start, duration, and track in HTML:
116116
```
117117

118118
This image starts at two seconds, remains for three seconds, and appears on
119-
track one. Animation timelines are paused and seekable, so Studio, the Player,
119+
track one. Animation timelines are paused and seekable, so the browser editor, the Player,
120120
and the renderer can request an exact moment without playing from the
121121
beginning.
122122

‎docs/concepts/variables.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ normal source edit when the structure itself needs to change.
4040
</div>
4141
</div>
4242

43-
## Use variables in Studio
43+
## Use variables in the browser editor
4444

45-
Studio can create and bind variables, preview overrides, and copy the reviewed
46-
values into a render command. Follow [Use variables and templates](/studio/variables)
45+
The browser editor can create and bind variables, preview overrides, and copy the reviewed
46+
values into a render command. Follow [Use variables and templates](/studio/assets-and-blocks#use-variables)
4747
for that complete workflow.
4848

4949
## Advanced: declare the approved inputs
@@ -72,7 +72,7 @@ Supported declared types are:
7272
| `font` | A font-family choice |
7373
| `image` | An image path or image value |
7474

75-
The type lets Studio show the right control and lets rendering catch invalid
75+
The type lets the browser editor show the right control and lets rendering catch invalid
7676
values.
7777

7878
### Say what a slot means, not where it sits

‎docs/docs.json‎

Lines changed: 52 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -147,54 +147,20 @@
147147
]
148148
},
149149
{
150-
"tab": "Studio",
150+
"tab": "Browser editor",
151151
"icon": "palette",
152152
"groups": [
153153
{
154-
"group": "Start in Studio",
155-
"pages": [
156-
"studio/index"
157-
]
158-
},
159-
{
160-
"group": "Edit",
154+
"group": "Browser editor",
161155
"pages": [
156+
"studio/index",
162157
"studio/canvas",
163158
"studio/timeline",
164-
"studio/animation",
165-
"studio/captions"
166-
]
167-
},
168-
{
169-
"group": "Audio",
170-
"pages": [
171159
"studio/audio-effects",
172-
"studio/voiceover-carve",
173-
"studio/audio-groups",
174-
"studio/audio-automation"
175-
]
176-
},
177-
{
178-
"group": "Build and reuse",
179-
"pages": [
180160
"studio/assets-and-blocks",
181-
"studio/variables",
182-
"studio/slideshows"
183-
]
184-
},
185-
{
186-
"group": "Finish and recover",
187-
"pages": [
188161
"studio/export",
189162
"studio/troubleshooting"
190163
]
191-
},
192-
{
193-
"group": "Reference",
194-
"pages": [
195-
"studio/source",
196-
"studio/shortcuts"
197-
]
198164
}
199165
]
200166
},
@@ -1058,7 +1024,7 @@
10581024
"header": "Build",
10591025
"items": [
10601026
{
1061-
"label": "Studio",
1027+
"label": "Browser editor",
10621028
"href": "/studio"
10631029
},
10641030
{
@@ -1158,7 +1124,7 @@
11581124
},
11591125
{
11601126
"source": "/guides/video-editor-cheatsheet",
1161-
"destination": "/studio/shortcuts"
1127+
"destination": "/studio/index#keyboard-shortcuts"
11621128
},
11631129
{
11641130
"source": "/guides/timeline-editing",
@@ -1215,12 +1181,12 @@
12151181
},
12161182
{
12171183
"source": "/guides/keyframes",
1218-
"destination": "/studio/animation",
1184+
"destination": "/studio/canvas#animate-with-keyframes",
12191185
"permanent": true
12201186
},
12211187
{
12221188
"source": "/studio/lint-and-agent",
1223-
"destination": "/studio/source",
1189+
"destination": "/studio/canvas#edit-the-source",
12241190
"permanent": true
12251191
},
12261192
{
@@ -1347,6 +1313,51 @@
13471313
"source": "/prompting/overlays-and-lower-thirds",
13481314
"destination": "/prompting/captions-catalog#overlays-and-lower-thirds",
13491315
"permanent": true
1316+
},
1317+
{
1318+
"source": "/studio/animation",
1319+
"destination": "/studio/canvas#animate-with-keyframes",
1320+
"permanent": true
1321+
},
1322+
{
1323+
"source": "/studio/audio-automation",
1324+
"destination": "/studio/audio-effects#automate-over-time",
1325+
"permanent": true
1326+
},
1327+
{
1328+
"source": "/studio/audio-groups",
1329+
"destination": "/studio/audio-effects#group-tracks",
1330+
"permanent": true
1331+
},
1332+
{
1333+
"source": "/studio/captions",
1334+
"destination": "/studio/assets-and-blocks#edit-captions",
1335+
"permanent": true
1336+
},
1337+
{
1338+
"source": "/studio/shortcuts",
1339+
"destination": "/studio/index#keyboard-shortcuts",
1340+
"permanent": true
1341+
},
1342+
{
1343+
"source": "/studio/slideshows",
1344+
"destination": "/studio/export#build-a-slideshow",
1345+
"permanent": true
1346+
},
1347+
{
1348+
"source": "/studio/source",
1349+
"destination": "/studio/canvas#edit-the-source",
1350+
"permanent": true
1351+
},
1352+
{
1353+
"source": "/studio/variables",
1354+
"destination": "/studio/assets-and-blocks#use-variables",
1355+
"permanent": true
1356+
},
1357+
{
1358+
"source": "/studio/voiceover-carve",
1359+
"destination": "/studio/audio-effects#make-music-sit-under-narration",
1360+
"permanent": true
13501361
}
13511362
],
13521363
"integrations": {

‎docs/guides/captions-and-recuts.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,6 @@ It replaces the full transcript in the existing captions and keeps the caption c
138138

139139
## Related topics
140140

141-
- [Edit captions in Studio](/studio/captions)
141+
- [Edit captions in the browser editor](/studio/assets-and-blocks#edit-captions)
142142
- [Work with voice, music, sound, and captions](/guides/voice-and-audio)
143143
- [Change the spoken edit with a custom video](/guides/general-video)

‎docs/guides/design-tools.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ npx hyperframes check
8484
npx hyperframes preview
8585
```
8686

87-
Then watch it move in [Studio](/studio) — stills cannot show timing.
87+
Then watch it move in [the browser editor](/studio) — stills cannot show timing.
8888

8989
## Related topics
9090

9191
- [Use the Figma integration](/guides/figma)
92-
- [Work on the project in Studio](/studio)
92+
- [Work on the project in the browser editor](/studio)
9393
- [Choose where to create](/guides/choose-creation-path)

‎docs/guides/export-and-share.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "Render a video to MP4"
33
sidebarTitle: "Render"
4-
description: "Review the project, run its checks, render through an agent, Studio, or the CLI, and deliver the right file or link."
4+
description: "Review the project, run its checks, render through an agent, the browser editor, or the CLI, and deliver the right file or link."
55
---
66

7-
Finish the same editable project through your agent, Studio, or the command
7+
Finish the same editable project through your agent, the browser editor, or the command
88
line. The route can change; the quality gate does not.
99

1010
## 1. Approve the project, not one good frame
@@ -20,7 +20,7 @@ before spending time on small visual details.
2020

2121
## 2. Run the project checks
2222

23-
Run the checks in Studio, ask your agent to run them, or use:
23+
Run the checks in the browser editor, ask your agent to run them, or use:
2424

2525
```bash
2626
npx hyperframes lint
@@ -48,14 +48,14 @@ Use the agent when a failed check may require a source change or when you want
4848
one person to manage the complete finish. The `/hyperframes` skill waits for
4949
render approval after the final preview.
5050

51-
### Use Studio
51+
### Use the browser editor
5252

5353
Open **Export**, choose the destination's format and size, and start the render.
5454
The Renders panel shows progress and keeps completed files available to
5555
download.
5656

5757
<div style={{ maxWidth: "42rem", margin: "1.5rem auto" }}>
58-
<Frame caption="Studio checking and rendering the same project shown in its editor.">
58+
<Frame caption="The browser editor checking and rendering the same project shown in its editor.">
5959
<video
6060
src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-check-render-loop-v2.mp4"
6161
poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-check-render-loop-v2.jpg"
@@ -93,7 +93,7 @@ Higher output resolution does not add detail to low-resolution media. A higher
9393
frame rate creates more frames; it does not improve motion authored for a lower
9494
cadence.
9595

96-
Use [Studio export](/studio/export) for its visible controls or the
96+
Use [export in the browser editor](/studio/export) for its visible controls or the
9797
[rendering reference](/guides/rendering) for formats, Docker, batch output, and
9898
advanced CLI behavior.
9999

@@ -153,11 +153,11 @@ npx hyperframes check
153153
```
154154

155155
Use [Troubleshooting](/guides/troubleshooting) for project and render failures,
156-
or [Studio troubleshooting](/studio/troubleshooting) when the problem is in the
156+
or [Browser editor troubleshooting](/studio/troubleshooting) when the problem is in the
157157
editor or its render queue.
158158

159159
## Related topics
160160

161-
- [Export and manage renders in Studio](/studio/export)
161+
- [Export and manage renders in the browser editor](/studio/export)
162162
- [Use advanced rendering options](/guides/rendering)
163163
- [Diagnose a project or render failure](/guides/troubleshooting)

‎docs/guides/faceless-explainer.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ the agent picks the palette. If you have colors, name them.
189189
- The ending lands the sentence you wanted the viewer to remember.
190190

191191
Ask the agent when the teaching sequence or evidence must change. Use
192-
Studio for a precise visual, timing, or animation correction.
192+
the browser editor for a precise visual, timing, or animation correction.
193193

194194
<Card title="Finish and share" icon="circle-check" href="/guides/export-and-share">
195195
Check the final project, render through your preferred surface, and review the file.

0 commit comments

Comments
 (0)