Skip to content

docs(studio): the browser editor in six pages, named the browser editor - #6379

Merged
ukimsanov merged 2 commits into
mainfrom
docs/browser-editor-v2
Oct 26, 2026
Merged

ukimsanov merged 2 commits into
mainfrom
docs/browser-editor-v2

Conversation

@ukimsanov

@ukimsanov ukimsanov commented Oct 26, 2026 •

Copy link
Copy Markdown
Collaborator

What

  • The browser editor gets its own name. The editor that npx hyperframes preview opens is called "the browser editor" on every user-facing page (guides, Prompt Guide, concepts, reference, help), so it can't be mixed up with the Studio app you download. The top tab and the footer link say Browser editor. History pages (changelog, weekly updates), package names (@hyperframes/studio) and film titles keep their wording.
  • 16 pages become 7, in one flat group (approved 22 Oct):
Page Title Folds in
/studio Edit in the browser editor shortcuts
/studio/canvas Edit on the canvas animation and keyframes, source and agent
/studio/timeline Edit timing on the timeline
/studio/audio-effects Mix audio voiceover carve, audio groups, automation
/studio/assets-and-blocks Captions, assets and variables captions, variables
/studio/export Export and slideshows slideshows
/studio/troubleshooting Browser editor troubleshooting

9 pages are removed, each with a 301 to its section, and listed in ALLOWED_DELETIONS with the reason.

  • A fresh screenshot of today's editor on the overview page (taken from preview on a real project, 25 Oct).

Why

Since the Studio app shipped, "Studio" means two different things in the docs, and people asking for the app land on editor pages (the editor tab is literally called "Studio"). The editor also had 16 thin pages; the 22 Oct review merged them into six a person can scan, plus the editor's troubleshooting page, without losing a URL.

How we'll know: fewer docs searches for "studio download" ending on editor pages; editor pages get longer visits.

Related work

Docs PR 6, after the Prompt Guide (#6378, merged); rebased onto main. One troubleshooting page for the whole site is in the structure PR, so the editor's own troubleshooting page stays for now.

How

  • Built from the reviewed drafts (docs/content-samples, 23 Oct), then every claim re-checked against today's packages/studio source:
    • all 124 bold UI labels on these pages exist in the editor's source, and the screenshot shows them (Design, Layers, Renders, Variables, Blur, Record a gesture, Describe a change to the agent, Lint, Export, Open in desktop app);
    • shortcuts: R records a gesture, K adds a keyframe, B and V switch the split and select tools, ⌘G groups (appHotkeysDispatch.ts, studioShortcuts.ts); auto-record keyframes and ripple edit are on by default (editingModeSlice.ts, playerStore.ts).
  • Fixed: the audio pages and the audio reference described a solo control (Hear only this, "half-lit" groups) and a group-row mute that the editor does not have; solo exists nowhere in the editor, runtime or engine. Muting is documented where it really 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, and muted audio is left out of the render (audioMixer.ts). A Prompt Guide line said the timeline "does not yet offer split or ripple"; both exist.
  • Kept main's later additions: the preview seek bar (feat(studio): add a preview seek bar #6103), and the variables Edit / Default lines from fix(sdk): keep font and image declarations after object edits #6281 (now in "Captions, assets and variables"; both labels checked in VariablesPanel.tsx and VariablesDeclarationForm.tsx).
  • Not used: 12 short editor clips recorded on 23 Oct (before the seek bar existed). They're listed on the tracker's "Media needs" tab to re-record on today's build.

Test plan

  • mint broken-links --check-redirects: no broken links; mint validate passes; bun run lint and prettier pass; the deletion guard and its tests pass
  • Manual testing performed: the 7 editor pages plus help, render, concepts, a Prompt Guide page and the lint rules loaded in Chrome on a local preview, 0 page errors, every internal link answers 200; each of the 9 old URLs redirects to its section
  • Documentation updated (if applicable)
  • Unit tests added/updated (docs only)
  • Comments follow CONTRIBUTING.md "Comments"

Copilot AI balanced review requested due to automatic review settings October 26, 2026 02:28
@mintlify

mintlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Oct 26, 2026, 5:40 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We checked only this PR's last commit. All nine deleted pages have explicit deletion allowances and redirects to real headings. Mint validation and redirect-aware broken links pass. The audio guide still describes controls and behavior absent from the editor; please finish that correction before merging.

Comment thread docs/studio/audio-effects.mdx Outdated
| --- | --- | --- |
| Mute | Silences a clip or a whole group | **Included** — muted audio is dropped from the render |

So **mute is a mix decision and solo is a listening tool**. You can leave a solo

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The nonexistent solo control is still documented here: this paragraph says solo is a listening tool, the next says soloed members make a group half-lit, and lines 372-373 troubleshoot solo export behavior. The group-row table at line 316 also offers Mute, but TimelineGroupHeader renders caret/name/count/FX/automation only; muting is available through other controls. We traced TimelineGroupRow, TimelineGroupHeader and TimelineTrackHeader rather than only searching labels. Remove the remaining solo claims and describe the actual place to mute a group.

@ukimsanov
ukimsanov force-pushed the docs/browser-editor-v2 branch from 15e2a1d to 6561b8d Compare October 26, 2026 04:34

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We checked the follow-up and rebased scope. The solo claims and group-row Mute are gone, and the replacement points to the track speaker, selected-clip toggle and Muted control that the editor renders. The earlier note is resolved. No new blocker found.

@miguel-heygen miguel-heygen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Independent approval pass at 6561b8db8abd87c5e2ab5f5f949253aae8748dbf.

The audio guide now points to track speaker controls, the selected-clip toggle and Muted, and explicitly says the group row has no mute (docs/studio/audio-effects.mdx:327–335). I traced TimelineTrackHeader, TimelineGroupHeader, PropertyPanelFlat and the media section; solo guidance is absent from both audio pages. All nine removed routes have reasoned allowances and redirects to real headings.

Audited: each layer and its cumulative integration, navigation/redirect/deletion-allowance contract, the prior review repairs and affected source consumers. Trusting: existing creative examples and previously moved prose beyond sampled source checks; no media generation or signed-in Studio acceptance. Rames’s prior COMMENT and same-head follow-up were read in full; the identified repairs are independently substantiated.

Evidence: public Mintlify branch preview (not production): current pages render, all 9 old routes fetch their intended pages with real section IDs; one old URL per layer also navigated through the actual browser/hash. Desktop/light, mobile and desktop/dark sampled. Repaired text is present in rendered DOM. Nine deletion-guard tests and independent missing-allowance negative controls pass. Hosted exact-head checks: 57 success/54 skipped, no failures; completed docs log confirms Mint validation and redirect-aware broken links passed.

Nonblocking preview limitations: the shared GitHub metadata widget receives 403s; page content and navigation remain usable, with no uncaught page errors. HAR zero-status records are not counted as successful requests. No installs, worktree, provider call, merge or deployment.

Verdict: APPROVE
Reasoning: No blocking finding remains in this exact docs layer or its integration with the captured parents; repaired claims, redirect coverage, rendered routes and hosted docs gates agree. Approval does not cover future rebases.

— Magi

@ukimsanov
ukimsanov added this pull request to the merge queue Oct 26, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Oct 26, 2026
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.

@miguel-heygen miguel-heygen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fresh rebase review at da23fa65358ae077e6b82813cf696da1f2b5d689. Git range-diff pairs both layer commits unchanged with the previously approved layer; comparison of every patch line (excluding object IDs and hunk offsets) also passes. Both layers descend from landed #6378 (12030b0e); its docs match the reviewed parent except the inherited v0.8.201 changelog entry.

Audited: actual layer/cumulative file census, browser-editor naming and audio controls, all current peer review/comment text, redirect/deletion integration and inherited changelog difference. All surviving layer files match their approved versions byte for byte except #6379's inherited changelog addition. Trusting: prior independent source-consumer audit and published-preview desktop/mobile/dark route evidence for these unchanged pages; no new browser or native/signed-in walk this round. Prior preview widget/icon 403 limitations remain disclosed in the original reviews.

Fresh offline controls pass: 15 deletion allowances/redirects and destination headings with missing-allowance negative control; repaired mute/update claims; 587 navigation entries retained/remapped; 448 catalog pages match exactly two intended substitutions; all 9 deletion-guard tests pass. The earlier optional generator-suite collection limitation remains; it is not claimed passing.

Current-head CI snapshot: {'skipped': 50, 'success': 52, 'in_progress': 3}. No failed check observed; running checks remain unconfirmed. New exact-head Validate docs job logs independently confirm Mint build validation and redirect-aware broken links passed. Each new completed log was fetched once; prior logs were not refetched. No install, worktree, merge or deployment.

Verdict: APPROVE
Reasoning: The rebase preserves the reviewed content and repairs, and fresh integration controls found no blocker. Approval covers this exact head; later rebases need their own check.

— Magi

@ukimsanov
ukimsanov added this pull request to the merge queue Oct 26, 2026
Merged via the queue into main with commit 0390f3f Oct 26, 2026
111 checks passed
@ukimsanov
ukimsanov deleted the docs/browser-editor-v2 branch October 26, 2026 07:00

This branch was successfully deployed

1 active deployment
staging - docs — da23fa65 Deployed Oct 26, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants