From 0390f3f908d1caa24ce609f402468eb52bf0c75c Mon Sep 17 00:00:00 2001 From: Ular Kimsanov Date: Mon, 26 Oct 2026 06:24:53 +0000 Subject: [PATCH] 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. --- docs/changelog.mdx | 6 +- docs/concepts/compositions.mdx | 2 +- docs/concepts/data-attributes.mdx | 6 +- docs/concepts/index.mdx | 14 +- docs/concepts/variables.mdx | 8 +- docs/docs.json | 93 ++--- docs/guides/captions-and-recuts.mdx | 2 +- docs/guides/design-tools.mdx | 4 +- docs/guides/export-and-share.mdx | 16 +- docs/guides/faceless-explainer.mdx | 2 +- docs/guides/figma.mdx | 2 +- docs/guides/general-video.mdx | 4 +- docs/guides/gsap-animation.mdx | 6 +- docs/guides/hyperframes-vs-remotion.mdx | 4 +- docs/guides/mcp.mdx | 6 +- docs/guides/media.mdx | 4 +- docs/guides/motion-blur.mdx | 10 +- docs/guides/motion-graphics.mdx | 2 +- docs/guides/music-to-video.mdx | 4 +- docs/guides/rendering.mdx | 6 +- docs/guides/slideshow.mdx | 6 +- docs/guides/troubleshooting.mdx | 12 +- docs/guides/vfx-chain.mdx | 6 +- docs/guides/video-components.mdx | 2 +- docs/guides/voice-and-audio.mdx | 4 +- docs/help.mdx | 16 +- docs/introduction.mdx | 2 +- docs/packages/studio.mdx | 41 ++- docs/prompting/color-grading.mdx | 8 +- docs/prompting/design-systems.mdx | 4 +- docs/prompting/editing-existing-videos.mdx | 10 +- docs/prompting/media-and-audio.mdx | 2 +- .../images/studio/editor-overview-v2.jpg | Bin 0 -> 266296 bytes docs/reference/audio-effects.mdx | 17 +- docs/reference/color-grading.mdx | 6 +- docs/reference/html-schema.mdx | 12 +- docs/reference/lint-rules.mdx | 18 +- docs/reference/speed-ramps.mdx | 8 +- docs/sdk/guides/timing-and-animation.mdx | 2 +- docs/studio/animation.mdx | 151 -------- docs/studio/assets-and-blocks.mdx | 111 +++++- docs/studio/audio-automation.mdx | 119 ------ docs/studio/audio-effects.mdx | 345 +++++++++++++++++- docs/studio/audio-groups.mdx | 105 ------ docs/studio/canvas.mdx | 296 ++++++++++----- docs/studio/captions.mdx | 54 --- docs/studio/export.mdx | 101 +++-- docs/studio/index.mdx | 285 +++++++-------- docs/studio/shortcuts.mdx | 97 ----- docs/studio/slideshows.mdx | 64 ---- docs/studio/source.mdx | 121 ------ docs/studio/timeline.mdx | 80 ++-- docs/studio/troubleshooting.mdx | 6 +- docs/studio/variables.mdx | 68 ---- docs/studio/voiceover-carve.mdx | 124 ------- scripts/check-no-main-deletions.mjs | 37 ++ 56 files changed, 1104 insertions(+), 1437 deletions(-) create mode 100644 docs/public/images/studio/editor-overview-v2.jpg delete mode 100644 docs/studio/animation.mdx delete mode 100644 docs/studio/audio-automation.mdx delete mode 100644 docs/studio/audio-groups.mdx delete mode 100644 docs/studio/captions.mdx delete mode 100644 docs/studio/shortcuts.mdx delete mode 100644 docs/studio/slideshows.mdx delete mode 100644 docs/studio/source.mdx delete mode 100644 docs/studio/variables.mdx delete mode 100644 docs/studio/voiceover-carve.mdx diff --git a/docs/changelog.mdx b/docs/changelog.mdx index 381c8fc841..382b28742d 100644 --- a/docs/changelog.mdx +++ b/docs/changelog.mdx @@ -5174,9 +5174,9 @@ what people hit first when they used it, and documents the whole system. - **Audio:** The audio effects system is documented. There are new pages for [mixing and presets](/studio/audio-effects), the [voiceover - carve](/studio/voiceover-carve), [groups, mute and - solo](/studio/audio-groups), and [automation - lanes](/studio/audio-automation), plus a [full + carve](/studio/audio-effects#make-music-sit-under-narration), [groups, mute and + solo](/studio/audio-effects#group-tracks), and [automation + lanes](/studio/audio-effects#automate-over-time), plus a [full reference](/reference/audio-effects) covering every effect, parameter range, preset, and attribute ([0eca7b1e0](https://github.com/heygen-com/hyperframes/commit/0eca7b1e0aef831bbab1265395f942378468afc0), [#3420](https://github.com/heygen-com/hyperframes/pull/3420)). diff --git a/docs/concepts/compositions.mdx b/docs/concepts/compositions.mdx index 82ae9dae73..e6cbead147 100644 --- a/docs/concepts/compositions.mdx +++ b/docs/concepts/compositions.mdx @@ -245,7 +245,7 @@ And the source file both cards share: [Variables](/concepts/variables) covers the types, the bindings that need no script, CLI overrides, and which value wins. If you are building tooling on `@hyperframes/core`, `extractCompositionMetadata()` reads the same -`data-composition-variables` array — that is how Studio builds its editing UI. +`data-composition-variables` array — that is how the browser editor builds its editing UI. ## Load a composition's own files from its script diff --git a/docs/concepts/data-attributes.mdx b/docs/concepts/data-attributes.mdx index e420a9cabc..ac3fa0af5b 100644 --- a/docs/concepts/data-attributes.mdx +++ b/docs/concepts/data-attributes.mdx @@ -17,7 +17,7 @@ a start, a duration, and a track: | ------------------ | ------------------------------------------------ | | `data-start` | When the element enters the composition timeline | | `data-duration` | How long its timeline slot lasts | -| `data-track-index` | Which Studio lane displays it (optional; the render ignores it) | +| `data-track-index` | Which browser editor lane displays it (optional; the render ignores it) | Add `class="clip"` to timed DOM and image elements. The runtime keys visibility off `data-start` rather than the class, but the shared `.clip` rule is what gives @@ -26,11 +26,11 @@ audio has no visual lifecycle. ## Tracks are not layers -Tracks are the rows Studio draws. They do not decide which element is in front, +Tracks are the rows the browser editor draws. They do not decide which element is in front, and they do not schedule anything. Use CSS `z-index` for paint order. Two clips on one track may overlap; the render composites both. Separate tracks -keep an intentional overlap, such as a crossfade, readable in Studio: +keep an intentional overlap, such as a crossfade, readable in the browser editor: ```html