Repository navigation
docs(guides): media pages titled by the task people search for - #6360
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
jrusso1020
left a comment
There was a problem hiding this comment.
Looks good. The color-grading URL redirects to the color section, all five media guides load cleanly, and mint validate and broken-links pass. Effect limits, cutout labels and the local vs HeyGen guidance match source. One should-fix inline.
| use **Cut out object here** in the app instead. | ||
|
|
||
| ## Common problems | ||
| <Accordion title="Fixes, quality and speed"> |
There was a problem hiding this comment.
This hides the troubleshooting table and quality commands in an Accordion, and docs/AGENTS.md says not to use accordions for troubleshooting. Can you make it a visible ## Fixes, quality and speed section so people can scan and link to it?
jrusso1020
left a comment
There was a problem hiding this comment.
The troubleshooting note is fixed: "Fixes, quality and speed" is now a visible heading, with the table and commands outside the accordion. The one new deletion exception is the folded color-grading page, and its redirect is still in docs.json. The guard plus its 9 tests pass. Nothing blocking from us.
miguel-heygen
left a comment
There was a problem hiding this comment.
Independent review of 7fe97271f08e75249ff1be8a302bc8daeb580c4f against 0ae48c9f33d20ab5a92f999e6e25f6bbc3d108ab. No blocking finding.
docs/guides/remove-background.mdx now exposes troubleshooting as a real heading and table. docs/docs.json preserves the color-grading URL with a permanent redirect to its existing effects section; the deletion exception names only that folded page. Rames's earlier visibility note is resolved.
Audited: all 14 changed files, media instructions, unchanged export body/title-only delta, redirected cross-links and exact deletion exception. Checked CLI remove-background outputs/inverse-alpha/quality behavior, media-use local/HeyGen contracts, grading limits and Desktop menu/key-banner labels (HFI source 66f122de; no native acceptance).
Executed: 9 deletion-guard tests; independent actual-file/deletion/redirect controls, including removal of an exception causing refusal and the disjoint seven-redirect union with #6359. All five changed public Mintlify PR-preview pages render; the old color-grading route reaches the actual section. Chromium verified mobile/dark layout without horizontal overflow and visible troubleshooting outside an accordion. Hosted exact-head Validate docs log records successful mint validate and mint broken-links --check-redirects.
Nonblocking cosmetic note: docs/guides/video-components.mdx's new Avatar presenter card uses icon="user-video"; its Font Awesome SVG request returned HTTP 403 in the preview (twice). The card's text and navigation remain usable. Other captured page-error output is empty; no other captured HTTP >=400. This is disclosed rather than counted as an error-free browser walk.
Trusting / limits: public PR preview and source checks do not prove native/provider workflows. No signed-in Studio session, model/media generation, dependency install, product edit, worktree, merge or deployment performed.
Approval covers only this exact head. It does not carry over to the announced rebase after #6359 merges; preserve both PRs' redirect and deletion-exception additions in that successor.
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 media routes, redirect, visible troubleshooting and relevant docs gates work; the isolated decorative-icon failure is cosmetic and does not block the task paths.
— Magi (desktop-review)
7fe9727 to
7978fd3
Compare
miguel-heygen
left a comment
There was a problem hiding this comment.
Independent re-review of 7978fd39e28a58340cd85afbceaa4f449f58ca07 against current base 5353171155473d1e75941306800d8909690c8cb1.
Audited: the actual 14-file incremental diff and range-diff from my approved 7fe97271. The media rewrite patch is unchanged except the docs.json insertion context; the second fix commit is patch-equivalent. The composed source preserves all six landed #6359 prompt redirects plus the color-grading redirect, all seven real target sections and all seven deletion exceptions. The new base's export/srcset and CLI timeline prose survive. This is a composition review, not an audit of every unrelated commit inherited from main.
Executed: 9 deletion-guard tests at this head; independent exact redirect/anchor/unique-source checks, incremental deletion/API-file census and removed-exception refusal negative control. Prior media-route, responsive and visible-troubleshooting browser evidence remains documented in review 5645990701; native/provider behavior was not exercised.
Fresh browser / CI: after Mintlify's updated deployment, Chromium followed all seven old URLs to their exact real section anchors. Public PR preview, not a production/native/provider session; console/page errors were captured separately. Exact-head Validate docs executed mint validate and broken-links --check-redirects successfully (job 121352686854, log fetched once). Final snapshot: 39 successful, 19 skipped, one neutral and six running checks; no failed check. The prior cosmetic icon note remains nonblocking.
Verdict: APPROVE
Reasoning: The rebased patch preserves both sets of redirects and deletion exceptions; source controls, fresh redirect behavior and the relevant docs gate pass at this exact head. Broader pending checks are not claimed passed.
— Magi (desktop-review)
What
The media pages, rewritten to the 22–23 Oct docs decisions:
/guides/voice-and-audio/guides/media-effects/guides/remove-background/guides/video-components/guides/export-and-share/guides/color-gradingfolds into the effects page (301 to its "Fix and grade the color" section), as decided on 22 Oct.Why
People type short task words. Docs search, 18 Sep–17 Oct (7,026 searches): voice 27, music 24, captions 23, background 13, photo 8, image 7, render 6, export 5, glitch 7; nobody typed "media effects". The pages also lead with the Studio app, where most people should start, and say plainly what is free and what uses HeyGen.
How we'll know: clicks per impression for these pages in Search Console, and fewer docs searches for these words that end without a click.
Related work
Reviewed together with 4a. The media overview (
/guides/media) stays for now: it holds "Reuse an approved recipe" (#5324), which has no other home yet.How
docs/content-samples), then checked against today'smain:skills/media-use); the Studio app's banner text, fromHeygenKeyStatus.tsx; captions in the Studio app go through HeyGen, and local transcription is the CLI's (Parakeet or Whisper).media-treatment --capabilities,packages/core/src/colorGrading.ts).packages/desktop); CLI outputs and--background-output(commands/remove-background.ts).Test plan
mint broken-links --check-redirects: no broken links;mint validatepasses;bun run lintand prettier pass/guides/color-gradingredirects to its new section