Walk your teamthrough the system.
Write a short YAML file next to your diagrams, API specs, and schemas. UIGraph plays it as a narrated video that moves to each part as it is explained.
walkthrough: checkout-flow title: How checkout works uses: diagram: checkout-flow api: checkout-api db: orders scenes:
1/4 · diagram · focus
Checkout starts in the storefront, which sends the cart to checkout-service.
Written next to
what it explains.
A video is a file in .uigraph/videos/. Scenes point at your diagrams, endpoints, and tables by name, so the video shows what is in the repo today. The CLI syncs it like any other artifact, and it appears under Docs.
Diagrams are drawn by UIGraph’s own diagram renderer, the same one you use on the canvas.
- diagram: { focus: [...] }
- Moves the camera to the named components and dims the rest.
- diagram: { highlight: [...] }
- Marks components without moving the camera.
- diagram: { trace: [...] }
- Follows a path through the diagram, one hop at a time.
- diagram: { messages: 1-5 }
- Steps through the messages of a sequence diagram.
- endpoint: POST /v1/checkout
- Shows the endpoint as a card, read from your OpenAPI spec.
- table: orders
- Shows the table and its columns, read from your schema.
One voice,
scene to scene.
Narration uses OpenAI text to speech by default, through the AI provider your workspace already uses. Other voice providers can be plugged in, and self-hosted teams can bring their own.
Scene 2 · word timings
- The0.00s
- service0.14s
- prices0.62s
- the1.02s
- cart,1.14s
- takes1.66s
- payment,1.98s
- and2.58s
- writes2.74s
- the3.10s
- order.3.22s
One continuous take
The whole script is recorded as one performance, so the voice carries from one scene to the next instead of restarting each time.
Captions that match the voice
Every word has a timing. Captions and on-screen changes follow the narration exactly.
Recorded once
Narration is generated on the server and cached. When you edit a line, only what changed is recorded again.
Or make one
in the Studio.
Not every video belongs in a repo. Start a new video in UIGraph, add, reorder, and duplicate scenes, and edit the narration and fields with a live preview. You can switch to the YAML at any time.
Start from
- Blank
- How-to
- Product update
- Onboarding
- Release notes
Videos from the repo
Videos synced from a repo are read-only in UIGraph, so the file stays the source. Use Duplicate to edit to make your own copy.
Catalog · Video styles
One style for every video.
Set your brand colours, fonts, corners, logo, and backgrounds once. Every video, playbook video, and thumbnail in the workspace uses it.
- Start from a built-in style.
- Fill in a short form.
- Upload a YAML file. A sample is there to download.
- Have AI create one from your design guide.
Catalog · Video templates
Every scene, as a live preview.
Browse each scene template and setting, played with your style, with the YAML to copy next to it. Add your own templates, or make one from a built-in scene.
Ready to share.
More on the way.
Every video gets a thumbnail made from a frame of the video, with a play badge and its length.
Coming soon
Screen scenes
Screenshots with zoom, spotlight, numbered markers, notes, and clicks. Before and after comparisons.
Scenes from UIGraph Maps
Screen journeys and frames from your maps, with their focal points.
Code and terminal scenes
Code with highlighted lines and diffs, terminal sessions, and screen recordings.
Sharing
Slack link previews, MP4 export, and public links.
Explain it once.
Keep it current.
Videos reference the same diagrams, specs, and schemas you already sync. Playbooks get a narrated video of their steps too.