Skip to content

docs: one Troubleshooting page, four tabs, and the start pages folded - #6380

Merged
ukimsanov merged 2 commits into
mainfrom
docs/structure-v2
Oct 26, 2026
Merged

ukimsanov merged 2 commits into
mainfrom
docs/structure-v2

Conversation

@ukimsanov

@ukimsanov ukimsanov commented Oct 26, 2026 •

Copy link
Copy Markdown
Collaborator

What

  • Four tabs instead of five: Make a video · Studio app · Catalog · Developers (picked 20 Oct). The browser editor becomes a group inside "Make a video". The first tab is grouped by what people came to do: Start here, Make a video, Use it with your agent, Compare, Tips for better videos, Images sound and footage, Browser editor, Help and updates. Skills and plugin setup move from Developers to "Use it with your agent". No page is lost from the menu (checked by script).
  • One Troubleshooting page (/help) for the whole site, organised by where the problem shows up: in the Studio app, in the preview and browser editor, renders and setup, plus Share feedback. It's built from today's four pages section by section, word for word, so nothing a person searches for disappears.
  • Six pages fold, each with a 301 and an ALLOWED_DELETIONS entry:
Old page Goes to
/guides/troubleshooting /help
/studio/troubleshooting /help#in-the-preview-and-browser-editor
/studio-app/troubleshooting /help#in-the-studio-app
/guides/feedback /help#share-feedback
/guides/choose-creation-path /quickstart (the three-door start page answers the same question)
/go-further /studio-app/edit-with-the-agent
  • Catalog pages stop linking to "Go further": the generator (scripts/generate-catalog-pages.ts) and the 448 generated pages now say "Put blocks together into one video" and "Add assets and Catalog items in the browser editor". Only those two lines change in each page.

Why

Four places answered "something went wrong", and people had to guess which one. The 22 Oct review merged them into one page a person scans by symptom (the four pages had ~880 human views a month between them, and the docs assistant got 61 error questions). The five tabs mixed "the editor" and "the app" at the top level; four tabs match the four jobs people come with.

How we'll know: fewer error questions to the docs assistant that end without a click; help-page visits that end on a section anchor.

Related work

Docs PR 7a, after the browser editor (#6379, merged) and the docs look (#6393, merged); rebased onto main. Next: 7b adds the FAQ and Free agents pages, 7c the Inspiration page.

How

  • Every Troubleshooting section is moved word for word from main: the Studio app part from docs(studio-app): show the app working, three new pages, today's UI #6223 (24 Oct, fact-checked), the preview port section from fix(cli): scope explicit preview port discovery #6242, the "HyperFrames runtime failed" section from fix(core): preserve composition startup error stacks #6353, feedback from guides/feedback.mdx. The 25 Oct drafts had condensed seven of these symptoms away; they're kept.
  • The Studio app page's "How updates arrive" section moves too, word for word, as the first Studio app entry: the update button, Settings > Updates and the Mac menu, Automatic updates, and stalled or failed checks. Every label was re-checked in today's app code.
  • The catalog pages are generated, so the fix is in the generator; the pages get only its two changed lines. A full regeneration also pulls unrelated drift (CSS fallbacks, a rewrite of the catalog menu), so that's left for a catalog PR.

Test plan

  • mint broken-links --check-redirects: no broken links; mint validate passes; bun run lint, the deletion guard and its tests, and generate-catalog-pages tests pass
  • Manual testing performed: Troubleshooting, quickstart, introduction, the catalog index and a block page, the AI-chat guide, the app install page, the editor overview and the developer overview loaded in Chrome on a local preview, 0 page errors, every internal link answers 200; each of the 6 old URLs redirects; the four tabs render
  • 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 26, 2026 02:28
@mintlify

mintlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Oct 26, 2026, 7:12 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.

We checked only this PR's last commit. All six deleted pages have explicit deletion allowances and redirects to real sections, and the four tabs keep the other navigation pages. All 448 generated detail pages match the two intended substitutions, and the generator's other edits are formatting. Troubleshooting is preserved apart from the update guidance noted inline. Broken links and nine deletion-guard tests pass; local Mint validation stalled.

Comment thread docs/help.mdx

The browser never opens, the page is unreachable, or the project does not load.
## In the Studio app

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 move drops the old Studio app troubleshooting page's entire "How updates arrive" section. The install page's Updates summary does not keep the Automatic updates toggle, the Mac menu route, or the "Could not check for updates" recovery instructions. Please keep those details in help or expand the install section and link to it; the current move is not word for word for this section.

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

We checked the follow-up and rebased scope. How updates arrive is restored word for word from the removed page, including the settings and recovery instructions. The original rebased patches are unchanged, and the combined stack's broken-link check passes. We did not rerun Mint validation or a live preview. No new blocker found.

@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 approval pass at 80b5053aebfd2f3b8a68db0f2d2d52f98d297a7c.

The restored “How updates arrive” section (docs/help.mdx:18–38) matches the removed section word for word, including settings and failure recovery. Sampled update labels/default behavior agree with the saved Desktop source. All six folded routes have reasoned allowances and redirects; all 587 prior navigation entries remain or map to a retained destination. All 448 generated detail pages are exactly the intended two substitutions; the generator reflects those substitutions.

Audited: each layer and its cumulative integration, navigation/redirect/deletion-allowance contract, the prior review repairs and affected source consumers. Trusting: existing creative examples and previously moved prose beyond sampled source checks; no media generation or signed-in Studio acceptance. Rames’s prior COMMENT and same-head follow-up were read in full; the identified repairs are independently substantiated.

Evidence: public Mintlify branch preview (not production): current pages render, all 6 old routes fetch their intended pages with real section IDs; one old URL per layer also navigated through the actual browser/hash. Desktop/light, mobile and desktop/dark sampled. Repaired text is present in rendered DOM. Nine deletion-guard tests and independent missing-allowance negative controls pass. Hosted exact-head checks: 57 success/54 skipped, no failures; completed docs log confirms Mint validation and redirect-aware broken links passed.

Nonblocking preview limitations: the shared GitHub metadata widget receives 403s; page content and navigation remain usable, with no uncaught page errors. HAR zero-status records are not counted as successful requests. The optional local generator-suite attempt did not collect in the partial source snapshot (missing transitive player module); the 448-file equivalence witness is independently passing. No installs, worktree, provider call, merge or deployment.

Verdict: APPROVE
Reasoning: No blocking finding remains in this exact docs layer or its integration with the captured parents; repaired claims, redirect coverage, rendered routes and hosted docs gates agree. Approval does not cover future rebases.

— Magi

@ukimsanov
ukimsanov added this pull request to the merge queue Oct 26, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Oct 26, 2026

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

Fresh rebase review at d33083bd0fc6ecef7e83318b6a235c4b9805a146. Git range-diff pairs both layer commits unchanged with the previously approved layer; comparison of every patch line (excluding object IDs and hunk offsets) also passes. Both layers descend from landed #6378 (12030b0e); its docs match the reviewed parent except the inherited v0.8.201 changelog entry.

Audited: actual layer/cumulative file census, four-tab navigation, retained help/update guidance and catalog substitutions, all current peer review/comment text, redirect/deletion integration and inherited changelog difference. All surviving layer files match their approved versions byte for byte except #6379's inherited changelog addition. Trusting: prior independent source-consumer audit and published-preview desktop/mobile/dark route evidence for these unchanged pages; no new browser or native/signed-in walk this round. Prior preview widget/icon 403 limitations remain disclosed in the original reviews.

Fresh offline controls pass: 15 deletion allowances/redirects and destination headings with missing-allowance negative control; repaired mute/update claims; 587 navigation entries retained/remapped; 448 catalog pages match exactly two intended substitutions; all 9 deletion-guard tests pass. The earlier optional generator-suite collection limitation remains; it is not claimed passing.

Current-head CI snapshot: {'skipped': 50, 'success': 49, 'in_progress': 5, 'neutral': 1}. No failed check observed; running checks remain unconfirmed. New exact-head Validate docs job logs independently confirm Mint build validation and redirect-aware broken links passed. Each new completed log was fetched once; prior logs were not refetched. No install, worktree, merge or deployment.

Verdict: APPROVE
Reasoning: The rebase preserves the reviewed content and repairs, and fresh integration controls found no blocker. Approval covers this exact head; later rebases need their own check.

— Magi

Folding the Studio app troubleshooting page into /help dropped its
"How updates arrive" section: the update button, Settings > Updates
and the Mac menu route, the Automatic updates toggle, and what to do
when an update stalls or cannot check. It is back word for word; every
label is still in the app.

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

Fresh restack review at 1a4b9e0bbcd63b8849b921100f991dc5e20e4826. Both layer commits pair unchanged in git range-diff with the approved d33083bd layer; normalized full patches also match. docs/help.mdx retains How updates arrive, and the six folded pages still have reasoned allowances, unique redirects and real destination headings. A missing-allowance negative control fails as intended.

Audited: own two-commit layer, current main integration and navigation/redirect/deletion contracts, all current peer texts. Trusting: the earlier independent 448-page/catalog and source-label audit for these unchanged patches; inherited main runtime changes are outside this incremental review. Public hosted /help renders the four tabs, update guidance and symptom headings without overflow or uncaught page errors. No native/provider/FPS claim.

Executed: 9 deletion-guard tests, six redirect/heading controls and exact patch-equivalence witness. No new install/worktree. The prior preview widget limitations remain attributed; no claim of a new full site crawl.

Current-head CI snapshot: {'skipped': 50, 'success': 54, 'in_progress': 1}. Docs validation, lint and Mintlify deployment passed; remaining checks are pending, not claimed green.

Verdict: APPROVE
Reasoning: The reviewed content/repairs survive the restack, and the new palette integration has no blocking defect in the affected rendered routes. Approval covers this exact head only.

— Magi

@ukimsanov
ukimsanov added this pull request to the merge queue Oct 26, 2026
Merged via the queue into main with commit a988afa Oct 26, 2026
111 checks passed
@ukimsanov
ukimsanov deleted the docs/structure-v2 branch October 26, 2026 07:57

This branch was successfully deployed

1 active deployment
staging - docs — 1a4b9e0b Deployed Oct 26, 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