Skip to content

docs(start): the Studio app first, the browser editor named, a showcase wall that renders - #6303

Merged
ukimsanov merged 1 commit into
mainfrom
docs/start-pages
Oct 25, 2026
Merged

ukimsanov merged 1 commit into
mainfrom
docs/start-pages

Conversation

@ukimsanov

Copy link
Copy Markdown
Collaborator

What

  • Quickstart keeps its URL and title and offers three ways in: the Studio app first (Mac and Linux, with a tagged download link), your own agent (today's steps, unchanged, the way in on Windows), and an AI chat with nothing to install. Its film is now the real first-video recording from the Studio app pages. The "Open Studio" box (which ran npx hyperframes preview) is renamed Open the browser editor.
  • Choose how to create lists the Studio app as the first of five places, with what you keep from each.
  • Go further says "browser editor" where it meant the browser editor, and points Mac users to Continue from Claude Code in the Studio app.
  • What is HyperFrames: the tile wall now renders. On the live site it never did: the wall used DocsVideo inside the same snippet file, which Mintlify can't resolve, so the page said "every tile below is a finished film" over an empty space. It now shows six team films from the homepage showcase and opens them in a plain <video>. The page's top film stays until its replacement is ready.
  • Top bar and footer: "Playground" (which opened hyperframes.dev's home page, the new-tab variant with noreferrer) becomes Download Studio, linking straight to the download with src=docs-navbar / src=docs-footer, so downloads that start in the docs are credited to the docs.

Why

Most first-time visitors land on the quickstart (225k Google impressions a year), and it never mentioned the Studio app, which is now the recommended way in. It also called the browser editor "Studio", which James's strategy doc names as the first thing to fix.

How we'll know: Mintlify views and time on page for /quickstart and /introduction against the two weeks before; downloads with src=docs-* in PostHog (studio_download_started).

Related work

Second of the docs PRs (Studio app pages #6223 merged). The agent pages (Claude Code, Codex, Cursor) follow in the next one. Every page's missing video is listed in the tracker's "Media needs" tab.

How

  • Fact check: every new or changed sentence checked against main of hyperframes-internal (the app, the download route) and hyperframes (CLI, skills, plugins), and against the merged Studio app pages: 17 claims, all held (Mac + Linux with Windows "coming soon" from studio/download/route.ts; agents from connect-your-agent; Undo per agent run; the connector's hosted rendering from the MCP server's own description; the Mac-only hand-off noted where it's linked).
  • ShowcaseWall keeps its reduced-motion handling; only the film list and the opened player changed.

Test plan

  • mint broken-links --check-redirects: no broken links; mint validate passes; bun run lint passes
  • Manual testing performed: the four pages loaded in Chrome on a local preview, 0 page errors; the wall renders 6 tiles and opens a film with sound; the top bar shows Download Studio with the tagged link
  • 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 09:33
@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, 9:39 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.

Reviewed exact 14aa4d0. No new blocking finding.

The three download entry points use the attribution route rather than installer/CDN URLs: docs/docs.json:1133,1153 and docs/quickstart.mdx:33 carry docs-footer, docs-navbar and docs-quickstart. All meet the supplied source sanitizer; none forces an OS. Live HEAD requests confirm the apex307 preserves the query, Mac user agents reach Install-HyperFrames.dmg and Linux user agents reach HyperFrames-amd64.deb; unknown systems reach the chooser. This checks routing, not live PostHog receipt.

The wall repair works under the actual Mintlify local preview, not only a standalone React harness: /introduction renders six tiles, opening selects the corresponding full-film URL with native controls, and Back restores all six. docs/snippets/docs-video.jsx:403–474 keeps its data/helpers inside ShowcaseWall and replaces the unresolved sibling-export reference with native video. Reduced-motion initialization and mid-session cleanup remain effective. Keyboard Enter opens a tile and activates Back; at390px the page has no horizontal overflow. Focus returns to body after that DOM replacement, as in the prior implementation; no new focus-restoration guarantee is claimed.

All four touched journeys loaded with zero page errors. Rendered navbar/footer and quickstart links contain the expected source values. Nineteen media URLs (six card/full/poster sets plus the quickstart demo) returned200; the quickstart local poster exists. These are reachability checks, not full-film decoding/audio acceptance. The browser-editor wording and CLI instructions agree with their destinations; the app/agent/hosted paths remain distinct.

Audited: all seven changed files, surrounding player behavior, navigation/anchors, adjacent app setup/agent guides, current download-route OS selection, actual Mintlify page rendering and controls. Fresh adversarial and review-gap passes completed. Mintlify dev initially failed while seeding its shared cache, then started on retry; mint validate and mint broken-links --check-redirects both completed successfully. No hosted deployment, native installation, signed-in flow or live analytics acceptance claimed.

Need: yes · Size: focused docs/embedded-player repair · Reuse: existing download attribution route and self-contained snippet · Simpler: native controls avoid the unresolved cross-export dependency.

— hf-review

Verdict: COMMENT
Reasoning: The tagged routes and rendered Mintlify wall behave as described in the audited controls; no new blocker found. Approval requires James or a trusted stamper's go.

@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 14aa4d0f170de59b1b529660b6cb81f5b242b947 against f51650d8a72ed472effff89da087c7e1cf6b2c98; no blocking finding.

docs/snippets/docs-video.jsx:403 keeps the showcase self-contained for Mintlify and preserves the muted tiles and reduced-motion cleanup. docs/quickstart.mdx:26 distinguishes the Studio app from the browser-editor/agent path while retaining the existing command and agent anchor.

Audited: all seven changed files, adjacent installation/continuation guides, CLI preview registration, and the download route/attribution sanitizer in locally available internal main da853f91. Independent public Mintlify preview checks loaded all four affected pages; Introduction rendered six tiles, opened a native-control film which reached readyState 4 and played, and Back restored six tiles. Quickstart's recording reached readyState 4, its agent anchor exists, and all three download tags render. Three live HEAD probes reached Mac DMG, Linux .deb and Windows system chooser. Focused immutable-source/config/poster assertions passed; no browser page errors observed.

Trusting / limits: Rames's exact-head review separately covers reduced-motion runtime, keyboard/mobile checks and all 19 media URLs. I did not repeat those exhaustive checks, install the app, use a signed-in agent/provider, or validate analytics attribution end to end. No new dependencies, product edits or worktree were needed.

Final exact-head CI snapshot: 24 successful and 36 skipped checks, no pending or failed check. The PR is open with GitHub mergeability blocked; this review does not claim merge clearance or take merge/release action.

Verdict: APPROVE
Reasoning: The docs consistently distinguish the two editors, the showcase works in the actual public Mintlify preview, and the tagged downloads resolve to the expected platform destinations. The bounded independent checks found no blocker.

— Magi

@ukimsanov
ukimsanov added this pull request to the merge queue Oct 25, 2026
Merged via the queue into main with commit f5ab771 Oct 25, 2026
60 checks passed
@ukimsanov
ukimsanov deleted the docs/start-pages branch October 25, 2026 09:49

This branch was successfully deployed

1 active deployment
staging - docs — 14aa4d0f 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