Skip to content

Commit b550960

Browse files
committed
docs: remove the Reference Project — nobody wants to be sent to GitHub
The "One project, open end to end" section on Examples was four cards linking into a GitHub folder. A reader on the docs site does not want to leave for a repo tree to read a BRIEF.md. The section is gone, and so is the examples/docs-reference-project folder it pointed at. Also removed the prose references that leaned on it: the Reference Project paragraph on Go further, the two GitHub-inspect links on Developers, and the mention on the Studio landing. Each was reworded to talk about "a project" generally rather than that specific folder. Examples is now purely the nineteen finished films plus Start from a template. The changelog entry recording #2977 is left as history. 0 broken links.
1 parent 06d2d6f commit b550960

22 files changed

Lines changed: 2 additions & 1576 deletions

docs/developers/index.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ cd my-video
2828
npx hyperframes preview
2929
```
3030

31-
The project is ordinary HTML. The Reference Project used in the beginner path
32-
starts with this real composition root:
31+
The project is ordinary HTML. A composition starts with this root:
3332

3433
```html
3534
<div
@@ -48,8 +47,6 @@ starts with this real composition root:
4847

4948
The project template supplies the composition root, viewport, and duration.
5049
HTML and CSS control what appears; `data-*` attributes control when it appears.
51-
You can [inspect the complete project](https://github.com/heygen-com/hyperframes/tree/main/examples/docs-reference-project)
52-
before choosing an integration surface.
5350
When the project is ready:
5451

5552
```bash

docs/examples.mdx

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -113,32 +113,6 @@ A PR, a Figma file, a design brief — turned into a finished film.
113113
</a>
114114
</div>
115115

116-
## One project, open end to end
117-
118-
This is the same small project used in the Quickstart. Its request, brief,
119-
source, revision notes, checks, and final render are all public.
120-
121-
```text
122-
Using /hyperframes, make a 10-second product intro for https://example.com.
123-
```
124-
125-
<CardGroup cols={2}>
126-
<Card title="Brief" icon="clipboard-list" href="https://github.com/heygen-com/hyperframes/blob/main/examples/docs-reference-project/BRIEF.md">
127-
What the agent decided before building anything.
128-
</Card>
129-
<Card title="Source" icon="folder-open" href="https://github.com/heygen-com/hyperframes/tree/main/examples/docs-reference-project">
130-
Every editable project file, exactly as it renders.
131-
</Card>
132-
<Card title="Revision" icon="pen-to-square" href="https://github.com/heygen-com/hyperframes/blob/main/examples/docs-reference-project/VERIFICATION.md#2-v1--v2">
133-
What changed between the first and second cut, and why.
134-
</Card>
135-
<Card title="Checks" icon="circle-check" href="https://github.com/heygen-com/hyperframes/blob/main/examples/docs-reference-project/VERIFICATION.md">
136-
The real gate output: lint, check, contrast, and the final render.
137-
</Card>
138-
</CardGroup>
139-
140-
The result is not a sealed demo. Open any stage above and use the same shape for
141-
your own project: request → brief → source → revision → render.
142116

143117
## Start from a template
144118

docs/go-further.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,6 @@ import { DocsVideo } from "/snippets/docs-video.jsx";
1818
The project does not change format as you gain control. Your agent, Studio, the
1919
SDK, the Player, and the renderer all work from the same HTML project.
2020

21-
The [Reference Project](https://github.com/heygen-com/hyperframes/tree/main/examples/docs-reference-project)
22-
continues the first-video example. Its first version is a real page capture on a
23-
10-second timeline. The revised version keeps that source and adds editable
24-
variables, narration, fixed captions, music, and sound.
25-
2621
## Choose by the size of the change
2722

2823
Use the agent for changes to the story or several scenes. Use Studio for the

docs/studio/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ import { DocsVideo } from "/snippets/docs-video.jsx";
1515
</div>
1616

1717
Studio is the visual editor for the same HTML project your agent and the CLI
18-
use. The Reference Project from the first-video guide opens here without an
19-
import or conversion. Open any project folder, then run:
18+
use. Any HyperFrames project opens here without an import or conversion. Open any project folder, then run:
2019

2120
```bash
2221
npx hyperframes preview

examples/docs-reference-project/.gitignore

Lines changed: 0 additions & 8 deletions
This file was deleted.

examples/docs-reference-project/BRIEF.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

examples/docs-reference-project/README.md

Lines changed: 0 additions & 165 deletions
This file was deleted.

0 commit comments

Comments
 (0)