Skip to content

docs: proposal — reorganize navigation into Start, Make and Studio tabs - #5941

Draft
ukimsanov wants to merge 1 commit into
mainfrom
docs/restructure-start
Draft

ukimsanov wants to merge 1 commit into
mainfrom
docs/restructure-start

Conversation

@ukimsanov

@ukimsanov ukimsanov commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Proposal, not ready to merge. The six new pages moved to #5944, which merges on its own into the current nav. This PR is now only the navigation restructure below. It waits until the docs structure is agreed; the pages it lists will drop out of the diff once #5944 lands.

What

Reorganizes the docs navigation and adds six pages that answer the questions people ask most. No file moves, no URL changes, no redirects.

Navigation, tab by tab

Tab Groups
Start (was the first half of Guides) Start here (What is HyperFrames, Is HyperFrames free?, Quickstart, Go further, Build on HyperFrames) · Choose your agent (Claude Code, Codex, Cursor) · Choose where to create · Compare (HyperFrames vs Remotion, Remotion alternatives, FAQ) · Explore · Help
Make Make a video (Choose a workflow, product launch, faceless explainer, PR to video, captions and recuts, motion graphics, music to video, slideshow, custom video) · Build the project
Prompt guide (was a group inside Guides) Overview · Levels 1–7 · Appendix, unchanged
Studio (merges "Studio" and "Studio app") Studio app (Mac, Linux) · Studio in the browser, which keeps its Edit, Audio, Build and reuse, Finish and recover, and Reference subgroups
Catalog, Developers Unchanged

New pages

Path Title
guides/is-hyperframes-free Is HyperFrames free?
guides/with-claude-code Make videos with Claude Code
guides/with-codex Make videos with Codex
guides/with-cursor Make videos with Cursor
guides/remotion-alternatives Remotion alternatives
faq HyperFrames FAQ

There are also two one-line cross-links: the cost note on Quickstart now links to the new "Is HyperFrames free?" page, and the Related topics on "HyperFrames or Remotion?" link to the alternatives page.

Why

  • Search Console (Sep 20 – Oct 17): about 97% of clicks come from brand searches. Almost nobody finds the docs by searching for a problem, so we need pages that answer real questions directly.
  • Docs assistant, last 28 days (5,367 conversations): the most common question types are installing the skills (~440 queries mention it), Claude Code (~360), voice and music (~380), HeyGen account or API key (~330), Studio, the app, or downloading (~305), free or pricing (~240), Codex (~110), license or commercial use (~70), Windows (~63), and Remotion (~24). These counts come from keyword matching, and one query can match several types.
  • Two tabs named "Studio" and "Studio app" confuse people: assistant queries mix them up ("Studio là free hay paid", "how do we download studio for windows").

Related work

  • Another branch is writing guides/html-to-mp4.mdx and guides/product-demo-video.mdx. Those files were not in this branch when it was finished, so add both to the Make tab's "Make a video" group once they land.

How

  • docs/docs.json was rewritten by a script that reuses the existing group objects, so their order, nesting, tags and expanded flags stay as they were.
  • Every fact on the new pages was checked against the repo:
    • the license: LICENSE, Apache 2.0;
    • install paths: packages/cli/src/commands/skills.ts, utils/skillsMirror.ts, and upstream skills agent dirs (Codex reads ~/.agents/skills; Cursor reads .agents/skills in the project and ~/.cursor/skills for the user);
    • plugin commands: guides/plugins.mdx;
    • billing: studio-app/connect-your-agent.mdx, deploy/cloud.mdx and guides/authentication.mdx;
    • telemetry: packages/cli.mdx#telemetry;
    • the render-time example: guides/performance.mdx.
  • The app downloading without sign-in comes from hyperframes-internal/packages/demo-next/src/app/studio/download/route.ts. That route also sends Windows visitors to "Coming soon", so the docs say only "Mac and Linux", with no date.
  • The "Is HyperFrames free?" page names no prices and no plans.
  • The Remotion alternatives page links each claim to the vendor's own site or pricing page and uses no comparative judgements.
  • The FAQ paraphrases real assistant queries. Nothing personal from the log is included.

Page set before and after (a script walks every nav leaf):

pages before: 608 (unique 608)
pages after:  614 (unique 614)
removed from nav: none
added to nav: faq, guides/is-hyperframes-free, guides/remotion-alternatives,
              guides/with-claude-code, guides/with-codex, guides/with-cursor
duplicates after: none
nav entries with no file: none

Test plan

  • mint validate: build validation passed
  • mint broken-links --check-redirects: no broken links found
  • bun run check:docs-catalog: no page lost (448 before, 448 after), all 447 gallery items present
  • bun run check:docs-snippet-motion: passes
  • bun run check:catalog-drift could not run locally: it needs a built packages/core (generated/runtime-inline). This PR does not touch the Catalog tab.
  • Reviewer: read the new pages on the preview deploy, especially the Codex $hyperframes prompt and the Cursor install picker steps
  • Documentation updated

🤖 Generated with Claude Code

Split the Guides tab into Start, Make and Prompt guide tabs, and merge the
two Studio tabs into one with app and browser groups. No file moves and no
URL changes: all 608 pages stay in the nav.

Add six pages for the top docs-assistant questions: Is HyperFrames free?,
Make videos with Claude Code, Codex and Cursor, Remotion alternatives, and
a FAQ.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Oct 20, 2026, 7:33 AM

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

@ukimsanov ukimsanov changed the title docs: reorganize navigation into start, make and studio tabs docs: proposal — reorganize navigation into Start, Make and Studio tabs Oct 20, 2026

This branch was successfully deployed

1 active deployment
staging - docs — 652b1293 Deployed Oct 20, 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.

1 participant