Skip to content

docs: add Studio app pages for Mac and Linux - #5063

Merged
miguel-heygen merged 10 commits into
mainfrom
docs/studio-app-pages
Oct 5, 2026
Merged

miguel-heygen merged 10 commits into
mainfrom
docs/studio-app-pages

Conversation

@miguel-heygen

@miguel-heygen miguel-heygen commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

What

A new Studio app tab in the docs for the HyperFrames Studio app for Mac and Linux (the downloads on hyperframes.dev/studio). Six short pages:

  1. Get the app: download and install on Mac (installer) or Linux (AppImage), first launch, sign in with HeyGen.
  2. Connect your agent: Claude Code (the app installs it and opens the sign-in; the two Terminal commands if a step fails) or Codex (copy the install and sign-in commands, then Check again).
  3. Make your first video: the Create your first video card (Hook, Proof, Turn, Call to action), your website or idea, Use this cut.
  4. Change your video with the agent: type a change; Select, Draw and Comment on the picture; Pending video edits sent as one request; Quick edit and gap suggestions on the timeline; Get inspired; undo.
  5. Export your video: quality, format and frame rate, where the file lands, export errors.
  6. Updates and troubleshooting: how updates arrive and restart, HyperFrames sign-in, Claude Code signed out, usage limits, Agent access blocking a step, other chat messages, and where projects, settings and exports live on each system.

Why

Requested: "let's add docs for the hyperframe studio app too" ... "in another pr". The hyperframes.dev/studio header is getting a Docs link, and the app had no pages. The existing Studio tab documents the web editor (npx hyperframes preview), so the app gets its own tab, named so it can cover other platforms later.

Related work

None.

How

  • Every button label, placeholder and message quoted on these pages was checked against the app's current source; nothing is described from memory or old copy. Features that are not on for everyone yet (for example sharing a link) are left out.
  • Screenshots were taken headless from a neutral fixture project ("Spring Launch") with a fresh profile. The Home shot is cropped above the Get inspired cards.
  • Images live in docs/public/images/studio-app/ (served as /public/..., like the catalog payloads), so they render on this PR's preview without a CDN upload. Happy to move them to the CDN path if a maintainer prefers.
  • Platform differences (Show in Finder vs Show in folder, Cmd vs Ctrl, where settings live) are named where they appear. Windows is left out: the download page does not offer it.
  • Docs only: docs/docs.json adds the tab; no code changes.

Test plan

  • npx mint validate: build validation passed
  • npx mint broken-links --check-redirects: no broken links (and, with one link deliberately broken on a scratch copy, it reports that link, so the check covers the new pages)
  • Each page rendered with mint dev and checked at 2x in light and dark, 1440 and 390 px wide; no broken images, and no table or code line runs past the screen edge at 390 px
  • Documentation updated

Studio app Home

Create your first video card

Project with the Export panel

Six short pages in a new Studio app tab: get the app, connect Claude Code or Codex, make your first video, change it with the agent, export, and updates and troubleshooting. Screenshots come from a neutral fixture project.
@mintlify

mintlify Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Oct 5, 2026, 12:35 PM

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

The app ships a Linux AppImage beside the Mac app. Install steps get Mac and Linux tabs, platform labels name both, and troubleshooting lists where projects, settings and exports live.
@miguel-heygen miguel-heygen changed the title docs: add Studio app pages for getting started with the Mac app docs: add Studio app pages for Mac and Linux Oct 5, 2026
First launch asks for HeyGen sign-in on the first click; the Mac download is a disk image with an installer inside; Select shows Prompt to edit; the Connect screen sends the waiting request itself; billing, export quality and update wording match the app. Open Terminal is described for both systems.
Three-column tables scrolled sideways at 390 px and the data-folder table broke paths mid-word; they become two-column tables and a short list.
Quoted UI text no longer carries its own period into a sentence or table cell, and the Mac install step says the HeyGen check can take a minute or two.
Quote the installer's HeyGen check, damaged-download and slow-check messages, and the stalled-update messages with Download it instead and Settings' Download the latest version.
@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Edit accuracy: accurate 2040 (base branch 2040), smooth 1672 of those

The gate passes.
Smoothness is reported in the artifact, not gated. A case fails only if it fails 2 of 3 runs.

Quarantined, measured but not gated (0)

Unstable (2)

  • nudge-none-pct-r0-root-z200: tracking 0.01, pressJump -, drop 0, reload 0.04, render 0.03, renderKey -, undo false, teleport true / tracking 0.01, pressJump -, drop 0, reload 0.04, render 0.03, renderKey -, undo true, teleport true / tracking 0.01, pressJump -, drop 0, reload 0.04, render 0.03, renderKey -, undo true, teleport true
  • nudge-none-px-r30-nested-z100: tracking 0.01, pressJump -, drop 0, reload 0, render 0.05, renderKey -, undo false, teleport true / tracking 0.01, pressJump -, drop 0, reload 0, render 0.05, renderKey -, undo true, teleport true / tracking 0.01, pressJump -, drop 0, reload 0, render 0.05, renderKey -, undo true, teleport true

A stalled update says 'The update is taking longer than it should' and a failed one 'The update didn't finish', in Framey's line and on the card alike; Try again starts the update over.

@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.

Review at f7c7bdf2. Approving the docs content.

About the release hold: nothing on this PR enforces it. It isn't a draft, it has no label, and no check fails, so an approval here can open the gate. Some of the copy these pages quote isn't in the app as currently released. It ships with the update you're holding for:

  • the installer's Checking it is really from HeyGen, HyperFrames is in Applications, Download again and took too long
  • the update corner's The update is taking longer than it should, The update didn't finish, Download it instead and Download the latest version

Today's app still says "Checking HeyGen's signature" and "Installing the update is taking longer than it should." If the hold should survive this approval, marking the PR as a draft until the app ships would do it.

Checked against the app source. I grepped every bolded UI string on the six pages against the app's source. All of them are there, either in the current app or in the pending release above. Specifically:

  • the agent states Ready, Not signed in, Not installed and Installed, but won't start
  • Bill runs to, While Framey works, Send, Take the step by step, Bring to front, Replace with and Ask Framey
  • the sign-in deadline, "within two minutes"
  • Check for Updates… in the Mac menu
  • Show in folder on Linux
  • .hyperframes-studio for projects
  • Export: MP4/WebM/MOV, 24/30/60 fps and the default of 1080p, MP4 at 30 fps. Project size replaces 1080p only when 1080p doesn't fit the project, and 4K is added when the project can take it.

Nav. The docs.json tab is valid, and every page it lists exists. /studio/index and /developers/cli resolve.

Images. Four JPGs, 1280 px wide, 64–167 KB, about 0.5 MB in total, so none are oversized.

Reuse / simplification. The existing Studio tab documents the web editor's Renders panel and its own troubleshooting, a different UI. A separate tab that links across with "Studio web editor" and "command line" is the right shape, and nothing here duplicates an existing page. Six short pages isn't over-built.

Non-blocking:

  1. In export.mdx, "1080p or Project size" reads as two choices. It's one choice whose label changes: "1080p (Project size when the project isn't 16:9 at 1080p)" would match the code.
  2. The link text in edit-with-the-agent.mdx says "Export and share", but the page doesn't cover sharing.
  3. The other docs images are on the static CDN. /public/images works, so moving them is optional.

— Rames

@miguel-heygen
miguel-heygen added this pull request to the merge queue Oct 5, 2026
Merged via the queue into main with commit 061a5c0 Oct 5, 2026
95 checks passed
@miguel-heygen
miguel-heygen deleted the docs/studio-app-pages branch October 5, 2026 15:21

This branch was successfully deployed

1 active deployment
staging - docs — f7c7bdf2 Deployed Oct 5, 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.

2 participants