Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
e7a6cb0
docs(skills): text corrections from prompt-guide validation
vanceingalls Jul 9, 2026
383dd35
docs(prompting): expand prompt guide into top-level multi-page section
vanceingalls Jul 9, 2026
816f580
docs(prompting): add by-video-type and by-feature prompt guide pages
vanceingalls Jul 9, 2026
a5ed39d
docs(prompting): strip title-duplicate headings from guide pages
vanceingalls Jul 9, 2026
0aebbc2
docs(prompting): validate prompts and embed renders across the guide
vanceingalls Jul 9, 2026
702a6bb
docs(prompting): serve guide renders from static.heygen.ai
vanceingalls Jul 9, 2026
99ff79b
docs(prompting): polish pass — verify facts against sources, fix stal…
vanceingalls Jul 9, 2026
2f958d1
docs(prompting): complete plan — variant validation, vocab clips, wor…
vanceingalls Jul 9, 2026
ead4341
docs(prompting): add Porting from Remotion page — the one workflow wi…
vanceingalls Jul 13, 2026
ba37b53
docs(prompting): add rule 7 — seeded + two-frame-hold motion for hand…
vanceingalls Jul 13, 2026
559dd0e
chore: merge main into fix/prompt-guide-validation-bugs, resolve conf…
vanceingalls Jul 13, 2026
c222b17
docs(prompting): approved design for novice-to-capstone guide arc
vanceingalls Jul 22, 2026
54051c2
docs(prompting): implementation plan for the guide arc restructure
vanceingalls Jul 22, 2026
b71ce85
chore: format prompt-guide-expansion plan (fixes Format CI)
vanceingalls Jul 22, 2026
a478898
docs(prompting): regroup Prompt Guide nav into novice-to-advanced levels
vanceingalls Jul 22, 2026
04b0b75
docs(prompting): level 1 — reframe workflow pages as first-win rides …
vanceingalls Jul 22, 2026
8de8545
docs(prompting): embed validated changelog-video render
vanceingalls Jul 22, 2026
68ab776
docs(prompting): fix Level 1 exit bridges to the plan's literal template
vanceingalls Jul 22, 2026
c8a64a2
docs(prompting): level 2 — control chapters with bridges + structure …
vanceingalls Jul 22, 2026
2ab72e5
docs(prompting): level 3 — life chapters with bridges
vanceingalls Jul 22, 2026
cd8c98e
docs(prompting): level 4 — capability chapters framed as additive
vanceingalls Jul 22, 2026
16224fd
docs(prompting): fix misquoted caption-color phrase in captions-catal…
vanceingalls Jul 22, 2026
c763543
docs(prompting): level 5 — voice, sound, and automatic media proxies
vanceingalls Jul 22, 2026
9eaf62e
docs(prompting): embed validated proxy-footage render
vanceingalls Jul 22, 2026
fe09437
docs(prompting): level 6 — scale chapters + variables CSS-shadow corr…
vanceingalls Jul 22, 2026
630ad48
docs(prompting): add storyboards chapter — prompting the plan, not th…
vanceingalls Jul 22, 2026
de96c05
docs(prompting): embed validated storyboard-mini render
vanceingalls Jul 22, 2026
00c6fd2
docs(prompting): appendix cheat sheet + post-guide lint rules as prom…
vanceingalls Jul 22, 2026
b14545a
docs(prompting): remove non-sequitur anatomy link from rule 1
vanceingalls Jul 22, 2026
6a2d506
docs(prompting): capstone chapter + overview rewritten as the arc's map
vanceingalls Jul 22, 2026
e016410
docs(prompting): fix capstone exit bridge to the literal template
vanceingalls Jul 22, 2026
6a6adb9
docs(prompting): final QA pass for the guide arc
vanceingalls Jul 22, 2026
48e359b
docs(prompting): fix stale six-rules references to match the seven-ru…
vanceingalls Jul 22, 2026
e6bea18
docs(prompting): rebuild capstone film with density contract — chrome…
vanceingalls Jul 22, 2026
87b2ec6
docs(prompting): capstone v2 — OSS Wrapped all-techniques film, two-r…
vanceingalls Jul 23, 2026
a90e343
docs(prompting): capstone v3 — The Timeline, one continuous camera jo…
vanceingalls Jul 23, 2026
b13457b
docs(prompting): capstone v4 — dwell-and-sweep rhythm, real brand fra…
vanceingalls Jul 23, 2026
6df2647
docs(prompting): close prompt gaps — chip path-binding and mural iris…
vanceingalls Jul 23, 2026
ef62ebd
docs(prompting): lower-third renders behind the subject — match film …
vanceingalls Jul 23, 2026
74346e1
docs(prompting): sync prompt to fixes — screen-fixed mural, ring-only…
vanceingalls Jul 23, 2026
871b8f2
docs(prompting): capstone depth region — chip occlusion + coil taper …
vanceingalls Jul 23, 2026
79525f9
docs(prompting): capstone honesty note + depth technique row cover 3D…
vanceingalls Jul 23, 2026
bd8437f
docs(prompting): thread capstone regions through the guide as each ch…
vanceingalls Jul 27, 2026
8f2e054
docs(prompting): capstone threads quote the verbatim prompt clause th…
vanceingalls Jul 27, 2026
01e993c
docs(prompting): fill gaps — vo-paced reveals, density contract, moun…
vanceingalls Jul 27, 2026
4d5953c
docs(prompting): sync capstone prompt — chip rides the coil, peel nee…
vanceingalls Jul 28, 2026
8ce65d0
docs(prompting): coil carries the wire stroke, anchors to the diving …
vanceingalls Jul 28, 2026
17e7974
docs(prompting): revert capstone prompt to the pre-audit film
vanceingalls Jul 28, 2026
4f6fb8f
docs(prompting): add "Avoiding the slideshow" — continuity contract +…
vanceingalls Jul 28, 2026
90a281b
docs(prompting): frame slideshow fix as two properties, camera as one…
vanceingalls Jul 28, 2026
bde474d
Merge remote-tracking branch 'origin/main' into fix/prompt-guide-vali…
vanceingalls Jul 28, 2026
9cbab0c
Merge remote-tracking branch 'origin/main' into fix/prompt-guide-vali…
vanceingalls Jul 28, 2026
44f9db4
docs(prompting): audit fixes — validation gate, framework vocabulary,…
vanceingalls Jul 29, 2026
d888be1
docs(prompting): validated showreel + handmade prompts, fix spec defe…
vanceingalls Jul 29, 2026
a3e8806
docs(prompting): warn on webgpu-only glass block, strengthen chart pr…
vanceingalls Jul 29, 2026
87843f2
docs(prompting): validated chart example, add duration-with-no-tail r…
vanceingalls Jul 29, 2026
8468771
docs(prompting): six more validated renders, tighten the prompts thei…
vanceingalls Jul 29, 2026
4d89bd4
docs(prompting): document layout waivers and the contrast-gate side e…
vanceingalls Jul 29, 2026
fda3d9a
docs(prompting): add fromTo back-render and round-linecap dot traps t…
vanceingalls Jul 29, 2026
770e79d
docs(prompting): refresh example gallery with motion grammar and name…
vanceingalls Jul 29, 2026
5a05182
docs(prompting): rebuild beat-synced slideshow — generated brutalist …
vanceingalls Jul 30, 2026
4260f12
docs(prompting): frame.md is the design spec, drop design.md references
vanceingalls Jul 30, 2026
1f4d00e
docs(prompting): add the motion-purpose filter, offset ratio, and pro…
vanceingalls Jul 30, 2026
d4bd291
docs(prompting): add per-rule A/B demos and the worker-boundary deter…
vanceingalls Jul 30, 2026
75dac80
docs(prompting): fix MDX parse error from an orphaned Warning close tag
vanceingalls Jul 30, 2026
cebf66e
docs(prompting): rule demos gain before/after prompts and exaggerated…
vanceingalls Jul 30, 2026
6f29f14
docs(prompting): lead the motion chapter with meaning, not amplitude
vanceingalls Jul 30, 2026
a17755d
docs(prompting): rebuild rule 1 demo around a motivated idle
vanceingalls Jul 30, 2026
dd4fd9c
docs(prompting): rebuild rule 4-6 demos around motivated subjects
vanceingalls Jul 30, 2026
cdac57c
docs(prompting): rebuild rule 1-3 demos around motivated subjects
vanceingalls Jul 30, 2026
8fb1482
docs(prompting): rebuild rule 2 as cross-fade vs camera move
vanceingalls Jul 30, 2026
73ebc7c
docs: address prompt guide review findings
vanceingalls Jul 30, 2026
fdf3ad8
docs: address remaining prompt guide feedback
vanceingalls Jul 30, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/concepts/compositions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ You can embed one composition inside another in two ways: loading from an extern
<Tab title="External file">
Reference another HTML file with `data-composition-src`. The framework automatically fetches the file, extracts the `<template>` content, mounts it, executes scripts, and registers the timeline.

`data-composition-src` paths resolve relative to the **project root**, not the referencing file — a nested composition one level deep still writes `compositions/foo.html`, never `../compositions/foo.html`.

```html index.html
<div
id="el-5"
Expand Down
87 changes: 85 additions & 2 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,83 @@
"concepts/determinism"
]
},
{
"group": "Prompt Guide",
"pages": [
"prompting/overview",
{
"group": "Level 1 — Your first video",
"pages": [
"prompting/product-launch",
"prompting/explainers",
"prompting/code-and-prs",
"prompting/captions-and-talking-heads",
"prompting/music-and-slideshows",
"prompting/motion-graphics"
]
},
{
"group": "Level 2 — Control",
"pages": [
"prompting/anatomy",
"prompting/specification-dial",
"prompting/vocabulary",
"prompting/visual-specs",
"prompting/examples"
]
},
{
"group": "Level 3 — Life",
"pages": [
"prompting/motion",
"prompting/transitions"
]
},
{
"group": "Level 4 — Substance",
"pages": [
"prompting/code-blocks",
"prompting/data-and-maps",
"prompting/overlays-and-lower-thirds",
"prompting/captions-catalog",
"prompting/generated-artwork",
"prompting/vfx-and-liquid-glass",
"prompting/runtimes-and-3d"
]
},
{
"group": "Level 5 — Voice and sound",
"pages": [
"prompting/media-and-audio"
]
},
{
"group": "Level 6 — Scale",
"pages": [
"prompting/design-systems",
"prompting/variables-and-templating",
"prompting/storyboards",
"prompting/editing-existing-videos",
"prompting/iterating",
"prompting/recreating-references",
"prompting/rendering-and-output",
"prompting/remotion-migration"
]
},
{
"group": "Level 7 — Capstone",
"pages": [
"prompting/capstone"
]
},
{
"group": "Appendix",
"pages": [
"prompting/rules-and-anti-patterns"
]
}
]
},
{
"group": "Guides",
"pages": [
Expand All @@ -89,7 +166,6 @@
"guides/claude-design",
"guides/claude-design-send-to-hyperframes",
"guides/open-design",
"guides/prompting",
"guides/hyperframes-vs-remotion",
"guides/gsap-animation",
"guides/keyframes",
Expand Down Expand Up @@ -413,5 +489,12 @@
"socials": {
"github": "https://github.com/heygen-com/hyperframes"
}
}
},
"redirects": [
{
"source": "/guides/prompting",
"destination": "/prompting/overview",
"permanent": true
}
]
}
2 changes: 1 addition & 1 deletion docs/guides/antigravity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ HyperFrames projects created with `npx hyperframes init` scaffold both `CLAUDE.m
## Next steps

<CardGroup cols={2}>
<Card title="Prompting guide" icon="message" href="/guides/prompting">
<Card title="Prompting guide" icon="message" href="/prompting/overview">
Vocabulary and patterns that produce better compositions.
</Card>
<Card title="Catalog" icon="grid-2" href="/catalog/blocks/data-chart">
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/claude-design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Then iterate:
## Next steps

<CardGroup cols={2}>
<Card title="Prompt Guide" icon="message" href="/guides/prompting">
<Card title="Prompt Guide" icon="message" href="/prompting/overview">
More prompt patterns for HyperFrames across Claude Code, Claude Design, and other agents.
</Card>
<Card title="@hyperframes/player" icon="play" href="/packages/player">
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/copilot-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Authorize via OAuth when prompted. See the [MCP guide](/guides/mcp) for full det
## Next steps

<CardGroup cols={2}>
<Card title="Prompting guide" icon="message" href="/guides/prompting">
<Card title="Prompting guide" icon="message" href="/prompting/overview">
Vocabulary and patterns that produce better compositions.
</Card>
<Card title="Catalog" icon="grid-2" href="/catalog/blocks/data-chart">
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ The MCP is a HeyGen-hosted product that wraps:
<Card title="Quickstart" href="/quickstart">
Try HyperFrames locally with the open-source CLI.
</Card>
<Card title="Prompting guide" href="/guides/prompting">
<Card title="Prompting guide" href="/prompting/overview">
Tips for getting the best results when working with AI agents.
</Card>
<Card title="Catalog" href="/catalog/blocks/data-chart">
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/open-design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Then iterate the same way as the Claude Design path:
<Card title="Claude Design Guide" icon="message" href="/guides/claude-design">
The closed-source flavor of the same workflow — useful when you don't have a CLI on your laptop.
</Card>
<Card title="Prompt Guide" icon="message" href="/guides/prompting">
<Card title="Prompt Guide" icon="message" href="/prompting/overview">
More prompt patterns for HyperFrames across Claude Code, Claude Design, Open Design, and other agents.
</Card>
</CardGroup>
6 changes: 3 additions & 3 deletions docs/guides/pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ npx hyperframes transcribe narration.wav
| `narration.txt` | The exact spoken text with pronunciation substitutions applied (`API` → `A P I`, `$2T` → `two trillion`). Distinct from `SCRIPT.md` so you can regenerate the audio later with a different voice without redoing the substitutions. |
| `transcript.json`| `[{ text, start, end }]` for every word. Every later step reads this for timing. |

Hyperframes ships multiple TTS adapters (Kokoro, ElevenLabs, HeyGen); see [`/media-use`](/guides/prompting) for the skill that picks one. After generating audio, update `STORYBOARD.md` with the real beat boundaries from `transcript.json`.
Hyperframes ships multiple TTS adapters (Kokoro, ElevenLabs, HeyGen); see [`/media-use`](/guides/skills#domain-skills-loaded-on-demand) for the skill that picks one. After generating audio, update `STORYBOARD.md` with the real beat boundaries from `transcript.json`.

**Gate:** `narration.wav`, `narration.txt`, and `transcript.json` exist. `STORYBOARD.md` beat timings reference real timestamps, not estimates.

Expand All @@ -153,7 +153,7 @@ This is where the storyboard becomes runnable HTML. Each composition is a self-c

For multi-beat videos, spawn a focused sub-agent per beat. Each one gets fresh context, the storyboard section for its beat, the asset paths it needs, and the relevant technique references. That produces noticeably better output than building every beat in one long-running context.

After each composition is built, run a self-review for layout, asset placement, and animation quality. The [`/hyperframes-core`](/guides/prompting) skill encodes the composition rules — required `class="clip"` attributes, `data-*` attribute semantics — and [`/hyperframes-animation`](/guides/prompting) covers GSAP timeline registration and adapter registries.
After each composition is built, run a self-review for layout, asset placement, and animation quality. The [`/hyperframes-core`](/guides/skills#domain-skills-loaded-on-demand) skill encodes the composition rules — required `class="clip"` attributes, `data-*` attribute semantics — and [`/hyperframes-animation`](/guides/skills#domain-skills-loaded-on-demand) covers GSAP timeline registration and adapter registries.

**Gate:** Every composition is self-reviewed. No overlapping elements, no misplaced assets, no static images sitting unanimated.

Expand Down Expand Up @@ -209,7 +209,7 @@ For a 5-second one-shot animation, a single hand-authored composition is fine; t
<Card title="Website to Video" icon="globe" href="/guides/website-to-video">
The full website-to-video guide built on this pipeline.
</Card>
<Card title="Prompting" icon="comment" href="/guides/prompting">
<Card title="Prompting" icon="comment" href="/prompting/overview">
How to invoke the pipeline through your AI agent.
</Card>
<Card title="Launch Videos" icon="rocket" href="/launch-videos">
Expand Down
Loading
Loading