Repository navigation
docs: add Studio app pages for Mac and Linux - #5063
Conversation
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.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 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.
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.
Edit accuracy: accurate 2040 (base branch 2040), smooth 1672 of thoseThe gate passes. Quarantined, measured but not gated (0) Unstable (2)
|
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
left a comment
There was a problem hiding this comment.
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-studiofor 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:
- 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. - The link text in
edit-with-the-agent.mdxsays "Export and share", but the page doesn't cover sharing. - The other docs images are on the static CDN.
/public/imagesworks, so moving them is optional.
— Rames
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:
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
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.docs/docs.jsonadds the tab; no code changes.Test plan
npx mint validate: build validation passednpx 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)mint devand 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