From 00bd2e5ae28207407acf14a0c2aa8d17fbb667d1 Mon Sep 17 00:00:00 2001 From: James Date: Mon, 23 Mar 2026 22:39:08 +0000 Subject: [PATCH 1/7] docs: add Mintlify documentation site Set up /docs directory with docs.json config, HeyGen branding (logo, favicon, #7559FF purple), and 18 MDX pages covering: - Getting started (introduction, quickstart) - Concepts (compositions, data attributes, frame adapters, determinism) - Guides (GSAP animation, templates, rendering, common mistakes, troubleshooting) - Package docs (core, engine, producer, studio, CLI) - Reference (HTML schema) and contributing guide Content adapted from existing repo docs (core/docs/, cli/src/docs/, README). Validated with `mint validate` and `mint broken-links`. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/concepts/compositions.mdx | 107 ++++++++++++++++++ docs/concepts/data-attributes.mdx | 79 ++++++++++++++ docs/concepts/determinism.mdx | 59 ++++++++++ docs/concepts/frame-adapters.mdx | 100 +++++++++++++++++ docs/contributing.mdx | 60 +++++++++++ docs/docs.json | 80 ++++++++++++++ docs/favicon.ico | Bin 0 -> 15406 bytes docs/guides/common-mistakes.mdx | 65 +++++++++++ docs/guides/gsap-animation.mdx | 69 ++++++++++++ docs/guides/rendering.mdx | 54 ++++++++++ docs/guides/templates.mdx | 47 ++++++++ docs/guides/troubleshooting.mdx | 68 ++++++++++++ docs/introduction.mdx | 58 ++++++++++ docs/logo/dark.svg | 1 + docs/logo/icon.svg | 62 +++++++++++ docs/logo/light.svg | 77 +++++++++++++ docs/packages/cli.mdx | 97 +++++++++++++++++ docs/packages/core.mdx | 58 ++++++++++ docs/packages/engine.mdx | 44 ++++++++ docs/packages/producer.mdx | 63 +++++++++++ docs/packages/studio.mdx | 40 +++++++ docs/quickstart.mdx | 84 +++++++++++++++ docs/reference/html-schema.mdx | 174 ++++++++++++++++++++++++++++++ 23 files changed, 1546 insertions(+) create mode 100644 docs/concepts/compositions.mdx create mode 100644 docs/concepts/data-attributes.mdx create mode 100644 docs/concepts/determinism.mdx create mode 100644 docs/concepts/frame-adapters.mdx create mode 100644 docs/contributing.mdx create mode 100644 docs/docs.json create mode 100644 docs/favicon.ico create mode 100644 docs/guides/common-mistakes.mdx create mode 100644 docs/guides/gsap-animation.mdx create mode 100644 docs/guides/rendering.mdx create mode 100644 docs/guides/templates.mdx create mode 100644 docs/guides/troubleshooting.mdx create mode 100644 docs/introduction.mdx create mode 100644 docs/logo/dark.svg create mode 100644 docs/logo/icon.svg create mode 100644 docs/logo/light.svg create mode 100644 docs/packages/cli.mdx create mode 100644 docs/packages/core.mdx create mode 100644 docs/packages/engine.mdx create mode 100644 docs/packages/producer.mdx create mode 100644 docs/packages/studio.mdx create mode 100644 docs/quickstart.mdx create mode 100644 docs/reference/html-schema.mdx diff --git a/docs/concepts/compositions.mdx b/docs/concepts/compositions.mdx new file mode 100644 index 000000000..5b1ce3def --- /dev/null +++ b/docs/concepts/compositions.mdx @@ -0,0 +1,107 @@ +--- +title: Compositions +description: "The fundamental building block of a Hyperframes video." +--- + +A composition is an HTML document that defines a video timeline. Every clip — video, image, audio — must live inside a composition. + +## Structure + +Every composition needs a root element with `data-composition-id`: + +```html +
+ +
+``` + +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. + +## Clip Types + +A clip is any discrete block on the timeline, represented as an HTML element with data attributes: + +- `