Skip to content

docs(guides): one page per kind of video, with its prompts folded in - #6359

Merged
ukimsanov merged 2 commits into
mainfrom
docs/make-guides
Oct 26, 2026
Merged

ukimsanov merged 2 commits into
mainfrom
docs/make-guides

Conversation

@ukimsanov

Copy link
Copy Markdown
Collaborator

What

The "make a video" guides, rewritten to the docs decisions of 22–23 Oct (from the approved sitemap and page review):

  • Each kind of video has one page. The product launch, explainer, PR, captions, motion graphics and music guides now hold their own Prompts that work (the verified prompts, variants and common mistakes). Six Prompt Guide pages that repeated them are removed with 301 redirects to those sections: /prompting/product-launch, explainers, code-and-prs, captions-and-talking-heads, music-and-slideshows, motion-graphics. The deck prompt moves to the presentation guide.
  • Start from a video you like. Each guide tells you how to give the Studio app a reference (a link, a file, or a pick from the inspiration feed) before describing anything.
  • The Studio app comes first. Steps use the app's real labels (Make something, Let's go, Start with a storyboard, Reference, Remix from inspiration); /hyperframes is named once per page, for people using their own agent.
  • Real films of each kind. The explainer page shows three styles side by side (a woodblock story, a phone-GPS explainer made from a reference in the Studio app, a 3D how-to). HyperFrames vs Remotion opens with a logged side-by-side run: the same request to Claude Code with only Remotion's skills and with only HyperFrames', both results unedited.
  • What to make becomes large playing tiles, two per row, with 3D, VFX and a data video added.
  • Approved titles: "Make a product launch video with AI", "Make an explainer video with AI", "Turn a GitHub PR into a video", "Add captions to a video with AI", "Make motion graphics with AI", "Make a music video or lyric video", "Make an interactive presentation with AI", "Make any other video", "Add an AI avatar presenter to a video", "HyperFrames vs Remotion", "What do you want to make?". URLs don't change.
  • No emojis; plain words.

Why

Today the same kind of video has two pages (the guide, and a Prompt Guide page for what to type) that compete in search and split readers. People arrive on the guides (the launch guide has 62k Search Console impressions), so the prompts move there. A reference is the fastest start: a video you half like beats a blank page. The titles use the words people type (docs search, the docs assistant and Google autocomplete, pulled 22 Oct).

How we'll know: the old prompting URLs fold into the guides in Search Console within a few weeks; clicks per impression on the retitled guides; Studio app downloads that start from these pages (src tags already tracked).

Related work

Docs PR 4a, reviewed with 4b (media pages). Earlier: #6223, #6303, #6352. The Remotion migration page moves to its own page in the Prompt Guide PR (decided 22 Oct). "Studio" meaning the browser editor gets renamed with the browser editor pages.

How

  • Built from the reviewed drafts (docs/content-samples, 22–23 Oct), then every claim re-checked against today's main of hyperframes and hyperframes-internal:
    • App labels found in packages/desktop source today; the Script tab is public from build b463 (feature flag desktop-script-tab).
    • Reference links, files and feed: docs/studio-app/reference-video.mdx.
    • PR videos credit commit authors and use the real release (skills/hyperframes/references/film.md).
    • Presenter mode shows the live slide, notes, "Up next" and an elapsed timer; P presents (packages/player/src/slideshow).
    • Avatars through your own agent: heygen auth login --oauth (skills/media-use).
    • The Remotion comparison numbers come from the run's own files: 750 s vs 710 s, 10 TypeScript files / 1,037 lines vs 4 HTML files / 822 lines, about 950 MB of node_modules vs none, and a music bed plus five sound effects in the HyperFrames result.
  • Fixed from the drafts: "transcription runs on your computer" (the Studio app transcribes through HeyGen), "removes the ums" (only long pauses can be cut), "a 30-second video in several minutes" (now "about 10 to 15 minutes", from three logged runs), the wrong avatar sign-in command, and links to pages that only exist in later PRs. Kept main's later fixes (fix(cli): preserve caption arrays during transcript reimport #6185 transcript import, fix(player): keep Next available for the final slide's reveals #6233 slideshow Next).
  • Not used: a 23 Oct "Reference tab" clip, because the app's Home has changed since.
  • New films go to the CDN as versioned files (docs/films/*-v1.mp4); the GPS film re-encoded at VMAF 96.5.

Test plan

  • mint broken-links --check-redirects: no broken links; mint validate passes; bun run lint and prettier pass
  • Manual testing performed: the 10 guides, What to make, 5 Prompt Guide pages, the quickstart and an agent page loaded in Chrome on a local preview, 0 page errors, every internal link and anchor answers 200; each of the 6 old URLs redirects to its new 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 25, 2026 23:04
@mintlify

mintlify Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Oct 25, 2026, 11:35 PM

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

Looks good. All six redirects land on real prompt sections, the workflow list and both comparison players render, and mint validate and broken-links pass. The app labels and skill rules I sampled match source. Two small notes inline. The comparison's timing, line counts and install size are as reported in the run, not re-measured.

Comment thread docs/guides/hyperframes-vs-remotion.mdx Outdated
to seconds. Roughly 80% of a typical composition translates mechanically.
to seconds.

The other 20% is the point of the skill. It refuses to translate what does not

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.

Nit: the 80% claim above was removed, so "The other 20%" no longer refers to anything. Maybe "The harder cases are the point of the skill."

@@ -110,7 +140,7 @@ export const WorkflowChooser = () => {
<div className="hf-workflow-routes" ref={gridRef}>

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 description says large playing tiles, two per row, but this is still one route per row (no grid on .hf-workflow-routes in custom.css). Either update the description or add the layout.

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

Both notes from our last pass are fixed: the chooser is two columns (one on phones) with no horizontal overflow, and the migration paragraph reads "The harder cases." The six deletion exceptions match the folded pages, and the guard plus its 9 tests pass. Nothing blocking from us.

@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 review of 90655e9da72b76919a375cfe7b9a1ac02e212122 against 0ae48c9f33d20ab5a92f999e6e25f6bbc3d108ab. No blocking finding.

docs/snippets/workflow-chooser.jsx keeps route data inside the named export, preserves reduced-motion cleanup, and gives every tile an accessible link. The six docs/docs.json redirects point at existing prompt sections, and the deletion-guard additions enumerate exactly those six folded files. Rames's two earlier notes are resolved at this head.

Audited: the ten guides, chooser, workflow page, CSS additions, navigation/redirects, changed cross-links and deletion exceptions; git/API file census agrees (30 files). Source checks include film/PR credit and release rules, media-use sign-in and free/paid contracts, slideshow controls, and Desktop labels at locally available HFI 66f122de (source evidence, not native acceptance).

Executed: 9 deletion-guard tests; independent exact-file/deletion/redirect checks, including a removed-exception negative control and the disjoint seven-redirect union with #6360. Published Mintlify PR preview: all 11 changed guide/chooser routes render; all six old URLs land on their real anchors. Chromium verified two desktop columns, one mobile column without overflow, keyboard activation of a tile, 13 paused/unloaded tiles under reduced motion, and loaded comparison players with manual playback. Captured page-error/console output is empty; no captured HTTP >=400 for this preview. Hosted exact-head Validate docs log independently records successful mint validate and mint broken-links --check-redirects.

Trusting / limits: comparison runtime/file-count/install-size figures and generation results remain attributed to the author's run; I did not repeat a paid/model run or native Studio workflow. Binary posters were checked through preview rendering. The environment was a public PR preview, not deployed production or a signed-in backend session. No install, product edit, worktree, merge or deployment.

Approval covers this exact head only. Both PRs edit the redirect tail and deletion allowlist; a subsequent rebase/composition needs a fresh check.

CI snapshot: 45 successful, 19 skipped checks; Windows engine-cli still running. No failed check. These are executed results at this head, not a claim that the remaining test has passed.

Verdict: APPROVE
Reasoning: The folded content's routes, responsive chooser and relevant documentation gates work at the reviewed head, and source checks found no blocking instruction or integration defect.

— Magi (desktop-review)

@ukimsanov
ukimsanov enabled auto-merge October 25, 2026 23:50
@ukimsanov
ukimsanov added this pull request to the merge queue Oct 25, 2026
Merged via the queue into main with commit 5353171 Oct 26, 2026
66 checks passed
@ukimsanov
ukimsanov deleted the docs/make-guides branch October 26, 2026 01:24

This branch was successfully deployed

1 active deployment
staging - docs — 90655e9d Deployed Oct 25, 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