Skip to content

Commit af5ebf0

Browse files
committed
docs: four more the source contradicts, one of them mine
**`declareVariable`'s field is `declaration`, not `decl`.** Documented wrong in three places across two SDK reference pages. This one fails *silently* — the handler reads `op.declaration`, gets undefined, and returns EMPTY at sdk/src/engine/mutate.ts:991. No throw, no patch, no error. A reader copies the example and nothing happens. types.mdx opens by claiming it was verified against types.ts, which is where the correct name is (line 134). **Colour grading says eighteen presets; the Grade panel has thirteen.** Eighteen is the combined total. The other five carry effects and live in the Effects panel — colorGrading.ts derives GRADE_PRESETS by filtering EFFECT_PRESETS out, and colorGrading.test.ts:25 asserts VHS Playback is *not* in Grade. I wrote that sentence today and used VHS Playback as the example, so the page sent a reader to Grade looking for something that is not there. The visual brief further down had the same error baked in; fixed before anyone shoots it. **`hyperframes render` on a slideshow does not fail — it lies.** The page said export "is not currently supported", which reads like the command errors. The skill is emphatic: a deck has no master root composition, so render resolves only the first slide and writes a silently truncated MP4 — six seconds of a forty-second deck, no warning. That is now a Warning saying exactly that. I also swept every documented edit-operation field against sdk/src/types.ts. Six looked wrong and five were my regex not stripping the `?` optional marker; `easeEach` and `resolvedSelector` are real, at types.ts:178-179. One genuine error out of that sweep, the one above.
1 parent d012537 commit af5ebf0

4 files changed

Lines changed: 16 additions & 8 deletions

File tree

‎docs/guides/color-grading.mdx‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,11 @@ nothing left in them, or the wrong shot.
3939
Select an image or video — on the canvas, in Layers, or on the timeline — and
4040
open **Grade** in the Inspector.
4141

42-
Start with a preset. There are eighteen, from Clean Studio and Skin Soft to VHS
43-
Playback, and Studio renders each as a thumbnail of **your** frame rather than
42+
Start with a preset. There are thirteen, from Neutral and Clean Studio to Night Lift, and Studio renders each as a thumbnail of **your** frame rather than
4443
someone else's sample. **Strength** dials the chosen look between nothing and
4544
full.
4645

47-
{/* VISUAL NEEDED (1): Studio's preset thumbnail grid — all eighteen presets on
48-
one real frame, Clean Studio through VHS Playback. */}
46+
{/* VISUAL NEEDED (1): Studio's preset thumbnail grid — all thirteen Grade presets on one real frame, Neutral through Night Lift. */}
4947

5048
Hold the compare button in the panel header to flash back to the original. On
5149
moving footage, scrub several places first — a grade that flatters one frame can

‎docs/guides/slideshow.mdx‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,17 @@ The agent confirms the audience, main outcome, and whether the deck needs
3333
reveals, optional branches, or presenter notes. You do not need to prescribe
3434
every slide before seeing the proposed structure.
3535

36-
If the result should play from beginning to end without a presenter, use a normal [video workflow](/workflows). A slideshow cannot currently be exported as one complete linear MP4; per-slide snapshots are supported.
36+
If the result should play from beginning to end without a presenter, use a normal [video workflow](/workflows). A slideshow cannot be exported as one linear MP4 yet.
37+
38+
<Warning>
39+
Do not run `hyperframes render` on a deck. It does not fail — a deck has no
40+
master root composition, so the render resolves only the **first** slide and
41+
writes a silently truncated MP4. You can get six seconds of a forty-second
42+
deck and no warning that anything is missing.
43+
44+
Use `hyperframes present` for the live deck, or `hyperframes snapshot` for
45+
per-slide stills.
46+
</Warning>
3747

3848
## What control does the presenter need?
3949

‎docs/sdk/reference/edit-operations.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ comp.dispatch({
264264
| `type` | Key fields | What it does |
265265
|--------|-----------|--------------|
266266
| `setVariableValue` | `id`, `value` | Sets a composition variable's current value by id. Value may be a string, number, boolean, `FontValue`, or `ImageValue`. Refuses to create an undeclared variable. |
267-
| `declareVariable` | `decl` | Creates a new variable declaration, or fully replaces an existing one (type, label, default, and all other schema fields — not just the value). The only op that creates the schema entry from scratch. |
267+
| `declareVariable` | `declaration` | Creates a new variable declaration, or fully replaces an existing one (type, label, default, and all other schema fields — not just the value). The only op that creates the schema entry from scratch. |
268268
| `removeVariable` | `id` | Removes a variable's declaration entirely. Live `var.{id}` overrides and `data-var-*` DOM references are left untouched. |
269269

270270
```typescript
@@ -299,7 +299,7 @@ comp.dispatch({
299299
// Create a new variable declaration
300300
comp.dispatch({
301301
type: "declareVariable",
302-
decl: {
302+
declaration: {
303303
id: "brandColor",
304304
type: "color",
305305
label: "Brand color",

‎docs/sdk/reference/types.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -745,7 +745,7 @@ type EditOp =
745745
| { type: "setClassStyle"; selector: string; styles: Record<string, string | null> }
746746
| { type: "setCompositionMetadata"; width?: number; height?: number; duration?: number }
747747
| { type: "setVariableValue"; id: string; value: string | number | boolean | FontValue | ImageValue }
748-
| { type: "declareVariable"; decl: CompositionVariable }
748+
| { type: "declareVariable"; declaration: CompositionVariable }
749749
| { type: "removeVariable"; id: string }
750750
| { type: "addGsapTween"; target: HfId; tween: GsapTweenSpec }
751751
| { type: "setGsapTween"; animationId: string; properties: Partial<GsapTweenSpec> }

0 commit comments

Comments
 (0)