From 0f6259d461cfb678d60ae7926d343fbe44aee925 Mon Sep 17 00:00:00 2001 From: ukimsanov Date: Wed, 5 Aug 2026 05:43:35 -0700 Subject: [PATCH] docs: correct three source-contradiction findings from review - edit-operations: E_NO_GSAP_TIMELINE is raised only by addGsapTween and addLabel (mutate.ts:1747), not the set/remove tween ops; drop the false 'dispatch() still applies structurally' claim (mutate.gsap.test.ts verifies zero patches); add the requirement to the Labels section where addLabel lives. - html-schema: data-media-start is read by parser + timing compiler + runtime; data-playback-start is a runtime-only alias, so a lone playback-start doesn't shift trim/split. Document the surfaces instead of claiming one universal value. - testing-local-changes: bun unlink cleanup used a relative cd that resolves under the video project; use an absolute checkout path. Flagged by Magi (P1 #2/#3, P2 #7) and Rames. --- docs/contributing/testing-local-changes.mdx | 7 ++++--- docs/reference/html-schema.mdx | 2 +- docs/sdk/reference/edit-operations.mdx | 8 ++++++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/contributing/testing-local-changes.mdx b/docs/contributing/testing-local-changes.mdx index eba5c1dd4..ea911bdfb 100644 --- a/docs/contributing/testing-local-changes.mdx +++ b/docs/contributing/testing-local-changes.mdx @@ -42,11 +42,12 @@ hyperframes preview ``` Remove the link when finished. `bun unlink` takes no package name — it -unregisters whichever directory you run it from, so go back to the CLI package -first: +unregisters whichever directory you run it from, so go back to the CLI package in +your HyperFrames checkout first (an absolute path, since you are now inside the +video project): ```bash -cd packages/cli +cd /path/to/hyperframes/packages/cli bun unlink ``` diff --git a/docs/reference/html-schema.mdx b/docs/reference/html-schema.mdx index ba63590a2..4d63b4f1a 100644 --- a/docs/reference/html-schema.mdx +++ b/docs/reference/html-schema.mdx @@ -122,7 +122,7 @@ Audio has no visual lifecycle. | Attribute | Applies to | Meaning | | --- | --- | --- | -| `data-playback-start`
(alias: `data-media-start`) | Video, audio, nested composition | Offset into the source file, used by trim and split. The two names are one value — `data-playback-start` wins if both are set. | +| `data-media-start`
(runtime alias: `data-playback-start`) | Video, audio, nested composition | Offset into the source file, used by trim and split. Prefer `data-media-start`: it is read everywhere — parser, timing compiler, and runtime. `data-playback-start` is a runtime-only alias that takes precedence in the player when both are set, but the compiler and parser read only `data-media-start`, so a lone `data-playback-start` will not shift trim/split timing. | | `data-playback-rate` | Video, audio, nested composition | Playback multiplier from `0.1` to `5` | | `data-volume` | Video and audio | Static volume from `0` to `1` | | `data-has-audio="true"` | Video | Declares that the video contributes audio | diff --git a/docs/sdk/reference/edit-operations.mdx b/docs/sdk/reference/edit-operations.mdx index 1a48c0f8e..ef394de25 100644 --- a/docs/sdk/reference/edit-operations.mdx +++ b/docs/sdk/reference/edit-operations.mdx @@ -76,7 +76,7 @@ Stable `code` values for `ok: false`: | `E_NO_GSAP_SCRIPT` | Op requires a GSAP `