Skip to content

Commit 2e4c2c4

Browse files
authored
Merge pull request #2109 from heygen-com/fix/prompt-guide-validation-bugs
docs: Prompt Guide as a novice-to-capstone arc + text corrections from validation
2 parents e0dc255 + fdf3ad8 commit 2e4c2c4

47 files changed

Lines changed: 3571 additions & 314 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/concepts/compositions.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ You can embed one composition inside another in two ways: loading from an extern
3737
<Tab title="External file">
3838
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.
3939

40+
`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`.
41+
4042
```html index.html
4143
<div
4244
id="el-5"

‎docs/docs.json‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,83 @@
7171
"concepts/determinism"
7272
]
7373
},
74+
{
75+
"group": "Prompt Guide",
76+
"pages": [
77+
"prompting/overview",
78+
{
79+
"group": "Level 1 — Your first video",
80+
"pages": [
81+
"prompting/product-launch",
82+
"prompting/explainers",
83+
"prompting/code-and-prs",
84+
"prompting/captions-and-talking-heads",
85+
"prompting/music-and-slideshows",
86+
"prompting/motion-graphics"
87+
]
88+
},
89+
{
90+
"group": "Level 2 — Control",
91+
"pages": [
92+
"prompting/anatomy",
93+
"prompting/specification-dial",
94+
"prompting/vocabulary",
95+
"prompting/visual-specs",
96+
"prompting/examples"
97+
]
98+
},
99+
{
100+
"group": "Level 3 — Life",
101+
"pages": [
102+
"prompting/motion",
103+
"prompting/transitions"
104+
]
105+
},
106+
{
107+
"group": "Level 4 — Substance",
108+
"pages": [
109+
"prompting/code-blocks",
110+
"prompting/data-and-maps",
111+
"prompting/overlays-and-lower-thirds",
112+
"prompting/captions-catalog",
113+
"prompting/generated-artwork",
114+
"prompting/vfx-and-liquid-glass",
115+
"prompting/runtimes-and-3d"
116+
]
117+
},
118+
{
119+
"group": "Level 5 — Voice and sound",
120+
"pages": [
121+
"prompting/media-and-audio"
122+
]
123+
},
124+
{
125+
"group": "Level 6 — Scale",
126+
"pages": [
127+
"prompting/design-systems",
128+
"prompting/variables-and-templating",
129+
"prompting/storyboards",
130+
"prompting/editing-existing-videos",
131+
"prompting/iterating",
132+
"prompting/recreating-references",
133+
"prompting/rendering-and-output",
134+
"prompting/remotion-migration"
135+
]
136+
},
137+
{
138+
"group": "Level 7 — Capstone",
139+
"pages": [
140+
"prompting/capstone"
141+
]
142+
},
143+
{
144+
"group": "Appendix",
145+
"pages": [
146+
"prompting/rules-and-anti-patterns"
147+
]
148+
}
149+
]
150+
},
74151
{
75152
"group": "Guides",
76153
"pages": [
@@ -89,7 +166,6 @@
89166
"guides/claude-design",
90167
"guides/claude-design-send-to-hyperframes",
91168
"guides/open-design",
92-
"guides/prompting",
93169
"guides/hyperframes-vs-remotion",
94170
"guides/gsap-animation",
95171
"guides/keyframes",
@@ -413,5 +489,12 @@
413489
"socials": {
414490
"github": "https://github.com/heygen-com/hyperframes"
415491
}
416-
}
492+
},
493+
"redirects": [
494+
{
495+
"source": "/guides/prompting",
496+
"destination": "/prompting/overview",
497+
"permanent": true
498+
}
499+
]
417500
}

‎docs/guides/antigravity.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ HyperFrames projects created with `npx hyperframes init` scaffold both `CLAUDE.m
135135
## Next steps
136136

137137
<CardGroup cols={2}>
138-
<Card title="Prompting guide" icon="message" href="/guides/prompting">
138+
<Card title="Prompting guide" icon="message" href="/prompting/overview">
139139
Vocabulary and patterns that produce better compositions.
140140
</Card>
141141
<Card title="Catalog" icon="grid-2" href="/catalog/blocks/data-chart">

‎docs/guides/claude-design.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Then iterate:
143143
## Next steps
144144

145145
<CardGroup cols={2}>
146-
<Card title="Prompt Guide" icon="message" href="/guides/prompting">
146+
<Card title="Prompt Guide" icon="message" href="/prompting/overview">
147147
More prompt patterns for HyperFrames across Claude Code, Claude Design, and other agents.
148148
</Card>
149149
<Card title="@hyperframes/player" icon="play" href="/packages/player">

‎docs/guides/copilot-cli.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Authorize via OAuth when prompted. See the [MCP guide](/guides/mcp) for full det
175175
## Next steps
176176

177177
<CardGroup cols={2}>
178-
<Card title="Prompting guide" icon="message" href="/guides/prompting">
178+
<Card title="Prompting guide" icon="message" href="/prompting/overview">
179179
Vocabulary and patterns that produce better compositions.
180180
</Card>
181181
<Card title="Catalog" icon="grid-2" href="/catalog/blocks/data-chart">

‎docs/guides/mcp.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ The MCP is a HeyGen-hosted product that wraps:
320320
<Card title="Quickstart" href="/quickstart">
321321
Try HyperFrames locally with the open-source CLI.
322322
</Card>
323-
<Card title="Prompting guide" href="/guides/prompting">
323+
<Card title="Prompting guide" href="/prompting/overview">
324324
Tips for getting the best results when working with AI agents.
325325
</Card>
326326
<Card title="Catalog" href="/catalog/blocks/data-chart">

‎docs/guides/open-design.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Then iterate the same way as the Claude Design path:
169169
<Card title="Claude Design Guide" icon="message" href="/guides/claude-design">
170170
The closed-source flavor of the same workflow — useful when you don't have a CLI on your laptop.
171171
</Card>
172-
<Card title="Prompt Guide" icon="message" href="/guides/prompting">
172+
<Card title="Prompt Guide" icon="message" href="/prompting/overview">
173173
More prompt patterns for HyperFrames across Claude Code, Claude Design, Open Design, and other agents.
174174
</Card>
175175
</CardGroup>

‎docs/guides/pipeline.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ npx hyperframes transcribe narration.wav
141141
| `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. |
142142
| `transcript.json`| `[{ text, start, end }]` for every word. Every later step reads this for timing. |
143143

144-
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`.
144+
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`.
145145

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

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

154154
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.
155155

156-
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.
156+
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.
157157

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

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

0 commit comments

Comments
 (0)