From bebaf679d9d699f3c4341a9f61f5492c7314ead0 Mon Sep 17 00:00:00 2001 From: ukimsanov Date: Mon, 3 Aug 2026 16:09:58 -0700 Subject: [PATCH] docs: rebuild developer and rendering reference --- docs/community/adopters.mdx | 31 +- docs/concepts/compositions.mdx | 234 +-- docs/concepts/data-attributes.mdx | 146 +- docs/concepts/determinism.mdx | 121 +- docs/concepts/frame-adapters.mdx | 159 +- docs/concepts/variables.mdx | 448 ++--- docs/deploy/aws-lambda.mdx | 30 +- docs/deploy/cloud.mdx | 266 +-- docs/deploy/gcp-cloud-run.mdx | 176 +- .../migrating-to-hyperframes-lambda.mdx | 79 +- docs/deploy/templates-on-lambda.mdx | 379 ++-- docs/packages/aws-lambda.mdx | 2 +- docs/packages/cli.mdx | 1754 ++++++++++------- docs/packages/core.mdx | 491 +---- docs/packages/engine.mdx | 453 +---- docs/packages/gcp-cloud-run.mdx | 2 +- docs/packages/lint.mdx | 10 +- docs/packages/parsers.mdx | 10 +- docs/packages/player.mdx | 247 +-- docs/packages/producer.mdx | 398 +--- docs/packages/sdk.mdx | 27 +- docs/packages/shader-transitions.mdx | 2 +- docs/packages/studio-server.mdx | 133 +- docs/packages/studio.mdx | 308 +-- docs/reference/html-schema.mdx | 485 ++--- docs/sdk/guides/canvas-integration.mdx | 91 +- docs/sdk/guides/editing-affordances.mdx | 4 + docs/sdk/guides/timing-and-animation.mdx | 80 +- docs/sdk/overview.mdx | 79 - docs/sdk/quickstart.mdx | 46 +- docs/sdk/reference/adapters.mdx | 17 +- docs/sdk/reference/composition.mdx | 10 +- docs/sdk/reference/edit-operations.mdx | 3 +- docs/sdk/reference/open-composition.mdx | 3 +- docs/sdk/reference/types.mdx | 5 +- docs/sdk/reference/utilities.mdx | 8 +- 36 files changed, 2608 insertions(+), 4129 deletions(-) delete mode 100644 docs/sdk/overview.mdx diff --git a/docs/community/adopters.mdx b/docs/community/adopters.mdx index df91e37f4..f9a9402ec 100644 --- a/docs/community/adopters.mdx +++ b/docs/community/adopters.mdx @@ -3,7 +3,7 @@ title: Adopters description: Organizations using HyperFrames in production or actively evaluating it. --- -The teams below are shipping with HyperFrames. If your organization uses HyperFrames — in production, in evaluation, or in a side project — we'd love to add you. +The teams below use HyperFrames in production or are actively evaluating it. If your organization uses HyperFrames — in production, in evaluation, or in a side project — we'd love to add you. ## How to add your organization @@ -16,46 +16,59 @@ Open a pull request that adds your team to [`ADOPTERS.md`](https://github.com/he If you'd rather not be listed publicly, we'd still love to hear about your usage — drop a note in [our Discord](https://discord.gg/EbK98HBPdk). -## Production +## Teams using or evaluating HyperFrames - + HeyGen logo Powers AI-generated video composition and rendering across HeyGen's video product surface. [@jrusso1020](https://github.com/jrusso1020) + - + tldraw logo Generates automated pull-request walkthrough videos with GSAP-animated code diffs, narration, and captions. [@steveruizok](https://github.com/steveruizok) + - + TanStack logo Exploring HyperFrames for short-form code demo videos and documentation. [@AlemTuzlak](https://github.com/AlemTuzlak) + - + OptinMonster logo Exploring HyperFrames for marketing and product video content. Angie Meeker + - + reap logo Powers agent-first AI video clipping, editing, and rendering across reap.video's creator and agent workflows. [@usamaabid](https://github.com/usamaabid) + + + + Typeframe logo + + Renders speech videos into shareable MP4 exports with word-timed typing captions and styled caption layouts. + + [@kiyeonjeon21](https://github.com/kiyeonjeon21) + - + THU-MAIC logo Powers OpenMAIC's one-click MP4 export for AI-generated interactive classrooms using self-contained HyperFrames compositions. @@ -63,4 +76,4 @@ If you'd rather not be listed publicly, we'd still love to hear about your usage -The HeyGen team's actual launch-video sources (the ones featured in product announcements) live at [hyperframes-launches](https://github.com/heygen-com/hyperframes-launches) — see [Launch Videos](/launch-videos) for the writeup. +The HeyGen team's actual launch-video sources (the ones featured in product announcements) live at [hyperframes-launches](https://github.com/heygen-com/hyperframes-launches) — see [Examples](/examples) for the writeup. diff --git a/docs/concepts/compositions.mdx b/docs/concepts/compositions.mdx index 2a668e1d2..cb56f5592 100644 --- a/docs/concepts/compositions.mdx +++ b/docs/concepts/compositions.mdx @@ -1,218 +1,76 @@ --- -title: Compositions -description: "The fundamental building block of a Hyperframes video." +title: "Understand compositions" +sidebarTitle: "Compositions" +description: "See how a HyperFrames project divides a video into timed, reusable parts." --- -A composition is an HTML document that defines a video timeline. Every clip -- video, image, audio -- lives inside a composition. +A composition is a piece of a HyperFrames project with its own size and timeline. The main composition is the finished sequence. Other compositions can be scenes, captions, title systems, or reusable visual parts inside it. -## Structure - -Every composition needs a root element with `data-composition-id`: - -```html index.html -
- -
+```text +Main video +├── Opening +├── Product demo +├── Customer quote +└── Closing ``` -The `index.html` file is the top-level composition. It can contain nested compositions within it. Any composition can be imported into another -- there is no special "root" type. +Each part is still HTML. Studio, the agent, and normal code tools all work on the same files. -## Clip Types +## What a composition controls -A clip is any discrete block on the timeline, represented as an HTML element with [data attributes](/concepts/data-attributes): +A composition brings three things together: -- `