Skip to content

docs: add canonical pipeline guide (#937)#943

Merged
miguel-heygen merged 1 commit into
heygen-com:mainfrom
CypherPoet:docs/canonical-pipeline-page
May 18, 2026
Merged

docs: add canonical pipeline guide (#937)#943
miguel-heygen merged 1 commit into
heygen-com:mainfrom
CypherPoet:docs/canonical-pipeline-page

Conversation

@CypherPoet
Copy link
Copy Markdown
Contributor

Closes #937.

What

Adds docs/guides/pipeline.mdx -- a dedicated guide for the 7-step
production pipeline (Capture → Design → Script → Storyboard → VO +
Timing → Build → Validate). Cross-references it from
website-to-video, quickstart, prompting, and launch-videos.

Why

Previously the pipeline was documented as a small table inside the
website-to-video guide. That under-sold it: The structure (and the
DESIGN.md / SCRIPT.md / STORYBOARD.md artifacts) is useful for
any multi-beat Hyperframes project, not just website captures, and
it's a natural orientation read for anyone learning the framework.

How

  • New page expands each step with: what the artifact is, what's in it,
    what the gate is for moving on, and how to iterate without re-running
    the whole pipeline. Includes a project-layout diagram.
  • Registered first in the Guides section in docs.json. It's
    orientation for the rest of the Guides, followed by website-to-video
    (the headline use case) and then the technique-specific guides.
  • website-to-video keeps a brief overview table and links to the new
    guide; deeper detail no longer duplicated.
  • Cross-links added wherever STORYBOARD.md / DESIGN.md were already
    referenced (launch-videos) or where the /website-to-hyperframes
    skill is named (prompting).

Test plan

  • mintlify dev: new page renders, all cross-links resolve, nav
    order matches the intended pipeline → website-to-video → ….
  • Verified the website-to-video page still reads coherently with
    the trimmed pipeline section.
  • No code changes; no unit tests applicable.

Move the 7-step production pipeline (Capture → Design → Script → Storyboard
→ VO + Timing → Build → Validate) into its own dedicated guide so it serves
any Hyperframes project, not just website-to-video. Expand each step with
file contents, project layout, gates, and iteration patterns. Reference the
new page from website-to-video, quickstart, prompting, and launch-videos.
@miguel-heygen miguel-heygen merged commit d0669fa into heygen-com:main May 18, 2026
33 checks passed
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.

Document canonical pipeline for hyperframes projects

2 participants