Skip to content

docs(prompting): the Prompt Guide as six topic pages - #6378

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

ukimsanov merged 2 commits into
mainfrom
docs/prompt-topics-v2

Conversation

@ukimsanov

Copy link
Copy Markdown
Collaborator

What

The Prompt Guide goes from a 34-page course to 6 topic pages plus 4 extras, as decided on 22 Oct ("6 topic pages"):

Page Title Folds in
/prompting/overview Ask for a great video anatomy, specification dial, iterating, rules and anti-patterns
/prompting/motion Ask for smooth motion and transitions transitions, vocabulary (its easing table)
/prompting/media-and-audio Add voice, music and sound audio effects and mixing
/prompting/captions-catalog Text, captions and code on screen code blocks, overlays and lower thirds
/prompting/color-grading Colour, effects, 3D and generated art visual specs, generated artwork, VFX and liquid glass, runtimes and 3D
/prompting/design-systems Brand, templates and storyboards variables and templating, storyboards

More prompt topics: verified examples, editing an existing video, recreating something you saw, and A full film, prompt by prompt (the capstone, renamed). Move from Remotion to HyperFrames sits next to HyperFrames vs Remotion, and Turn data into an animated video sits with the make guides. "Rendering and output" moves into the CLI rendering guide as "Ask the agent for the right output".

16 pages are removed, each with a 301 to the exact section that now holds it. The "Level 1–7" course framing, "Next:" tails and chapter callbacks are gone.

Why

The course made people read in order. Searchers land on one page and leave. Six topic pages answer what people actually ask ("make the motion smoother", "add music", "captions in my brand"), and each URL that had visits still lands on its content.

How we'll know: Prompt Guide pages get more views per visit and fewer exits in the first 10 seconds (PostHog docs pageviews); the folded URLs pass their traffic to the topic pages in Search Console.

Related work

Docs PR 5, after 4a (#6359) and 4b (#6360), both merged. The browser editor (PR 6) and site structure (PR 7a) are stacked on it.

How

  • Built from the reviewed drafts (docs/content-samples, 22 Oct). 348 lines are new wording; everything else moved from the existing pages. The new lines were checked against today's main:
    • the motion fix table matches the skill's own rules (skills/hyperframes/references/motion.md, for example "too fast" slows every zoom and pan to 0.7×);
    • music catalog and the free path (skills/media-use); the Studio app's Start with a storyboard; catalog block names (every link opens).
  • Changed from the drafts, because they contradict the skill's current motion rules: an "ambient polish" section that told people never to let a title hold still and to keep it "breathing" with a slow push, and a matching "Avoid / Instead" pair. A landed title holds still now, as motion.md says.
  • /hyperframes appears only where it's about your own agent ("the Studio app does this for you"); prompts are written to work typed as is.
  • main's later fix to the rendering guide (docs: align render, fps and transcribe docs with the CLI #6166) is kept; the new section is added below it.

Test plan

  • mint broken-links --check-redirects: no broken links; mint validate passes; bun run lint and prettier pass
  • Manual testing performed: the 12 Prompt Guide pages and the rendering guide loaded in Chrome on a local preview, 0 page errors, every internal link and anchor answers 200; each of the 16 old URLs redirects to its 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 26, 2026 02:27
@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, 4:34 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 this PR's last commit. All 16 deleted pages have explicit deletion allowances and redirects to real sections, and the sampled motion and audio guidance matches the skills. Broken links pass. Mint validation stalled locally, so we have no validation or preview pass to claim. One small agent-invocation correction is inline.

Comment thread docs/prompting/overview.mdx Outdated

The guide is one arc, novice to advanced. Each level is what you can do once you've read it — read them in order, or jump straight to whichever gap matches where you are:
In the Studio app there is nothing to set up. With your own agent, install the skills once:
[one paste](/quickstart#with-your-agent). Then start each request with `/hyperframes`.

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.

Please keep the agent-specific invocation caveat. This now tells every own-agent user to start with /hyperframes, while our Codex guide correctly uses $hyperframes (guides/with-codex.mdx:43). The previous overview explicitly allowed non-Claude agents to invoke it another way.

The overview told every own-agent user to start with /hyperframes; Codex
uses $hyperframes, and other agents have their own way. The line now
names both and keeps the caveat the old page had.

@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. The setup now names Claude Code and Cursor's /hyperframes, Codex's $hyperframes, and the alternate-agent caveat. Our invocation note is resolved. 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 81912653dc6fc3f37f073a3edbab561ed9bf0c94.

The overview preserves /hyperframes for Claude Code/Cursor, $hyperframes for Codex and the alternate-agent caveat (docs/prompting/overview.mdx:24–26). The motion table agrees with the skill: landed titles stop and zoom/pan speed scales to 0.7×. All 16 removed routes have reasoned allowances and unique permanent redirects to real headings.

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 16 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: 47 success/19 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; a list-ordered navigation icon also returns 403; page content and navigation remain usable, with no uncaught page errors. HAR zero-status records are not counted as successful requests. 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
Merged via the queue into main with commit 12030b0 Oct 26, 2026
66 checks passed
@ukimsanov
ukimsanov deleted the docs/prompt-topics-v2 branch October 26, 2026 05:32

This branch was successfully deployed

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