Skip to content

docs: connect product-film close-ups to the full workspace - #6209

Merged
miguel-heygen merged 1 commit into
heygen-com:mainfrom
5nahCIvoLaF:docs/product-film-choreography
Oct 26, 2026
Merged

miguel-heygen merged 1 commit into
heygen-com:mainfrom
5nahCIvoLaF:docs/product-film-choreography

Conversation

@5nahCIvoLaF

@5nahCIvoLaF 5nahCIvoLaF commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

What

Clarify how a product-launch film connects independently animated UI components to the real workspace they belong to. Update both the authoring reference and the user-facing guide, with the matching shipped skill fingerprint.

Why

A real production iteration exposed two opposite failure modes: a sequence of authentic full-page screenshots still read like slides, while a component-only revision lost the overall product experience. Reducing copy also removed explanations the viewer needed. A later background revision needed changes to both scene styles and timeline color tweens.

The existing guidance already permits rebuilding the moving part and pulling back into the product. This makes that advice actionable without inventing product interactions or prescribing new timing defaults.

Related work

Searched open PRs for overlapping launch/workspace/close-up guidance; none found. This is a self-contained documentation clarification, with no separate issue, runtime/API changes, new catalog items, or generated catalog artifacts.

How

  • Add an establish-workspace → isolate-action → return-result sequence to the launch reference.
  • Distinguish verified source material from a shot list; keep real labels, values and supported states.
  • Explain that less copy still needs context, and that builds should unfold within a shot.
  • Include intermediate-frame review and background revisions across root, scene surfaces and color tweens.
  • Add a copyable request and a review criterion to the existing product-video guide.
  • Keep the existing size constraints and player-reveal guidance within the three steps, removing the overlapping bullets.
  • Regenerate skills-manifest.json to match the edited reference.

Test plan

  • Read root AGENTS.md, CONTRIBUTING.md, TRIAGE.md and docs/AGENTS.md; used Bun 1.4.4.
  • bun run lint:skills — skill lint, cross-references and core budgets pass.
  • node scripts/check-skill-mirror.mjs — mirrors match.
  • bun packages/cli/scripts/gen-skills-manifest.ts --check — all seven skills are in sync.
  • oxfmt --check skills/hyperframes/references/types/launch.md skills-manifest.json — passes. MDX is outside the formatter's matched files; reviewed the MDX diff manually.
  • node scripts/check-comment-citations.mjs, node scripts/comment-ratchet.mjs, and git diff --check — pass.
  • mint broken-links — no broken links.
  • Conventional commit validated with commitlint; GitHub signature is VALID/Verified.
  • Manually reviewed both full pages, the suggested prompt, source fidelity, and the exact three-file diff. No runtime code or HTML composition examples changed.
  • mint validate — full documentation build validation passed.
  • Unit tests/build/typecheck: not run for this prose-only change. oxlint has no applicable source files in this diff.
  • No source-code comments were added or changed.

@mintlify

mintlify Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit b2ff9e6.

Approve preview

@5nahCIvoLaF
5nahCIvoLaF marked this pull request as ready for review October 24, 2026 08:50

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

Thanks for the clear write-up. The workspace, close-up, return structure fits the existing launch guidance well: it keeps the "real UI, real labels" rule and adds no new timing or size numbers. I ran the skill lint, core-skill budget, mirror and formatter checks on this branch, and all pass.

A few small things:

  • launch.md: "while a tour shows the site as it is" refers to a "tour", but the skill has no tour type or definition, so an agent can't tell what it's being contrasted with. I'd drop the comparison or call it a site walkthrough.
  • product-launch-video.mdx: "colour revision" sits on a page that otherwise says "Color", and the docs mostly use "color". Worth matching.
  • Optional: steps 2 and 3 partly repeat the "Rebuild only the piece the beat uses" and "Pull back to reveal..." bullets right below. Folding them together would keep the reference shorter, but I'm fine either way.

CI hasn't run on this branch yet (fork workflows need a maintainer to approve them), so I'm leaving a comment rather than an approval for now. The content looks good to me once the wording nits are settled and the checks are green.

Verdict: COMMENT
Reasoning: Content is sound and local lint/format checks pass, but no required CI check has run on the fork yet, so it can't be approved; remaining notes are minor wording.

@5nahCIvoLaF
5nahCIvoLaF force-pushed the docs/product-film-choreography branch from c7010d1 to 210fa2f Compare October 26, 2026 00:32

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

Thanks for the update. All three notes from the last round are addressed: the "tour" comparison is gone, the docs page now says "color" throughout, and the size and pull-back rules are folded into steps 2 and 3 without losing any of their wording. I also checked that the regenerated skills manifest matches the edited reference at this head, and it does.

The content looks ready to me. The CI workflows on this branch are still waiting for a maintainer to approve them, so I'm leaving a comment for now; once they run green I'm happy to approve.

Verdict: COMMENT
Reasoning: Every earlier note is fixed and the manifest is in sync, but no CI workflow has run on the fork head yet, so it cannot be approved.

@5nahCIvoLaF
5nahCIvoLaF force-pushed the docs/product-film-choreography branch from 210fa2f to b2ff9e6 Compare October 26, 2026 01:34

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

CI has now run on the fork head and everything is green. The content is the one I checked at the last round: the "tour" comparison is gone, the docs say "color" throughout, the size and pull-back rules sit in steps 2 and 3, and the skills manifest is in sync. Thanks for the quick fixes.

Verdict: APPROVE
Reasoning: All earlier notes are fixed, the manifest is in sync, and all checks pass at this head.

@miguel-heygen
miguel-heygen added this pull request to the merge queue Oct 26, 2026
Merged via the queue into heygen-com:main with commit ecc2396 Oct 26, 2026
62 checks passed
SanHsien added a commit to SanHsien/hyperframes that referenced this pull request Oct 26, 2026
Merge 20 more upstream commits (acd0bc3..ad4d3fa, v0.8.205: heygen-com#6403,
heygen-com#6363, heygen-com#6209, heygen-com#6395, heygen-com#6424, heygen-com#6426, heygen-com#6442, heygen-com#6430, heygen-com#6402, heygen-com#6435, heygen-com#6439,
heygen-com#6449, heygen-com#5436, heygen-com#6455 and docs). No conflicts. Record the 11 open PRs
heygen-com#6440-heygen-com#6458 and issue heygen-com#6443 in docs/DECISIONS.md (none adopted), re-check
the earlier open PRs, and advance the commit watermark to ad4d3fa, the
PR watermark to heygen-com#6458 and the issue watermark to heygen-com#6443.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
@5nahCIvoLaF
5nahCIvoLaF deleted the docs/product-film-choreography branch October 30, 2026 10:46
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.

2 participants