Skip to content

Commit 31366d7

Browse files
committed
docs: draw the project model instead of describing it twice
The page that explains how the whole thing works had one Studio screenshot, 13 table rows, and two ASCII trees doing a diagram's job. Two mermaid diagrams now. The first is the page's central claim made visible — agent, Studio, CLI, SDK and Player all reading and writing one project folder, with the render falling out of it. The second replaces the ASCII composition tree with the same structure carrying real times and the file each scene lives in, which the ASCII version could not show. Verified rendering in the browser, not assumed.
1 parent f595a7d commit 31366d7

1 file changed

Lines changed: 21 additions & 6 deletions

File tree

‎docs/concepts/index.mdx‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@ A HyperFrames project is a folder your agent can create and you can keep
88
editing. Its HTML is the video: it describes the scenes, timing, motion, media,
99
and reusable parts that HyperFrames plays or renders.
1010

11+
One folder of HTML is the whole video. Every tool below reads and writes those
12+
same files — there is no export step between them and no second version of the
13+
project.
14+
15+
```mermaid
16+
flowchart TD
17+
S["Your project folder<br/>HTML, CSS, media"]
18+
A["Agent<br/>story and structure"] <--> S
19+
T["Studio<br/>what you can point at"] <--> S
20+
C["CLI<br/>check, preview, render"] <--> S
21+
K["SDK and Player<br/>inside your own product"] <--> S
22+
S --> R["renders/final.mp4"]
23+
```
24+
1125
## The source is the project
1226

1327
The agent, Studio, CLI, SDK, and Player do not create separate versions of the
@@ -60,12 +74,13 @@ A **composition** is a finite, seekable piece of the project. The main
6074
composition is the complete sequence. Other compositions can be scenes,
6175
captions, title systems, or visuals reused more than once.
6276

63-
```text
64-
Main video
65-
├── Opening
66-
├── Product demo
67-
├── Customer proof
68-
└── Closing
77+
```mermaid
78+
flowchart LR
79+
M["index.html<br/>the main composition"]
80+
M --> O["Opening<br/>0s - 4s"]
81+
M --> P["Product demo<br/>4s - 10s<br/>compositions/product-demo.html"]
82+
M --> C["Customer proof<br/>10s - 15s"]
83+
M --> Z["Closing<br/>15s - 18s"]
6984
```
7085

7186
Each part is still HTML. A larger project stays manageable because a scene can

0 commit comments

Comments
 (0)