Skip to content

Commit f720eb7

Browse files
committed
docs: lead the Quickstart with a paste-to-agent block, cut the Examples link wall
Two things a non-technical reader hits that the pages did not help with. **Quickstart made you do it by hand before you could ask.** Install through an interactive picker, choose the right group, restart the agent, then type a prompt — four manual terminal steps before anything happens. The copy-to-agent affordance existed but sat at the bottom of the page, after the step it would have replaced, and it copied only the prompt. It leads now, with the whole thing in one visible block: install, make, open the preview. It uses `hyperframes skills update` rather than the interactive `skills add`, which is the command the README already says agents should run — non-interactive, exactly the core set. The manual steps stay below for anyone who wants to see them. Plain code fence rather than the AgentAction component, deliberately: that component renders a Copy button and never shows the request, so a reader copies something they cannot read. Mintlify fences already carry a copy button and show the text. **Examples had four GitHub cards where one belongs.** Brief, Source, Revision, Checks — two of them pointing into a gate-output report. That is showing homework, not helping someone who came to see finished work. The render stays, with one link into the folder.
1 parent b36f69a commit f720eb7

2 files changed

Lines changed: 23 additions & 26 deletions

File tree

docs/examples.mdx

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -59,27 +59,8 @@ Each preview links to the complete source project.
5959

6060
## One project, open end to end
6161

62-
This is the same small project used in the Quickstart. Its request, brief,
63-
source, revision notes, checks, and final render are all public.
64-
65-
```text
66-
Using /hyperframes, make a 10-second product intro for https://example.com.
67-
```
68-
69-
<CardGroup cols={2}>
70-
<Card title="Brief" icon="clipboard-list" href="https://github.com/heygen-com/hyperframes/blob/main/examples/docs-reference-project/BRIEF.md">
71-
What the agent decided before building anything.
72-
</Card>
73-
<Card title="Source" icon="folder-open" href="https://github.com/heygen-com/hyperframes/tree/main/examples/docs-reference-project">
74-
Every editable project file, exactly as it renders.
75-
</Card>
76-
<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">
77-
What changed between the first and second cut, and why.
78-
</Card>
79-
<Card title="Checks" icon="circle-check" href="https://github.com/heygen-com/hyperframes/blob/main/examples/docs-reference-project/VERIFICATION.md">
80-
The real gate output: lint, check, contrast, and the final render.
81-
</Card>
82-
</CardGroup>
62+
The same ten-second project the Quickstart builds. This is its actual render,
63+
and the folder behind it is public — not a sealed demo.
8364

8465
<div style={{ maxWidth: "36rem", margin: "1.5rem auto" }}>
8566
<DocsVideo
@@ -89,8 +70,10 @@ Using /hyperframes, make a 10-second product intro for https://example.com.
8970
/>
9071
</div>
9172

92-
The result is not a sealed demo. Open any stage above and use the same shape for
93-
your own project: request → brief → source → revision → render.
73+
<Card title="Open the project on GitHub" icon="folder-open" href="https://github.com/heygen-com/hyperframes/tree/main/examples/docs-reference-project" horizontal arrow>
74+
Every file exactly as it renders — the composition, the caption overlay, the
75+
measured word timings, and the brief the agent worked from.
76+
</Card>
9477

9578
## Start from a template
9679

docs/quickstart.mdx

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: "Install the HyperFrames skills, make one short request, and contin
55

66
import { QuickstartContinuationGrid } from "/snippets/quickstart-continuation-grid.jsx";
77
import { DocsVideo } from "/snippets/docs-video.jsx";
8-
import { AgentAction } from "/snippets/agent-action.jsx";
98

109
<div className="hf-docs-video-frame">
1110
<DocsVideo
@@ -21,6 +20,23 @@ import { AgentAction } from "/snippets/agent-action.jsx";
2120
costs.
2221
</Note>
2322

23+
## The short way: hand it to your agent
24+
25+
If you already have a coding agent open in a folder, paste this and skip the
26+
rest of the page. It installs the skills, makes the video, and opens the
27+
preview — you only change the URL.
28+
29+
```text
30+
Set this folder up for HyperFrames and make me a video.
31+
32+
1. Run: npx hyperframes skills update
33+
2. Then, using /hyperframes, make a 10-second product intro for https://example.com
34+
3. Open the local preview when it is done and tell me the project folder.
35+
```
36+
37+
Swap `https://example.com` for the page you want the video to show. Everything
38+
below is the same thing done by hand, if you would rather see each step.
39+
2440
## 1. Install the skills
2541

2642
Run this in your project folder:
@@ -51,8 +67,6 @@ the same project.
5167

5268
<QuickstartContinuationGrid />
5369

54-
<AgentAction request="Using /hyperframes, make a 10-second product intro for https://example.com." />
55-
5670
## Related topics
5771

5872
<CardGroup cols={2}>

0 commit comments

Comments
 (0)