Skip to content

Replace the README video with one of OpenBot as it ships today - #1060

Open
jerelvelarde wants to merge 2 commits into
CopilotKit:mainfrom
jerelvelarde:jerel/readme-1-0-video
Open

jerelvelarde wants to merge 2 commits into
CopilotKit:mainfrom
jerelvelarde:jerel/readme-1-0-video

Conversation

@jerelvelarde

@jerelvelarde jerelvelarde commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor
openbot-readme-demo-v2.mp4

The problem

The video at the top of the README is the first thing most people see of OpenBot, and it shows a product
that no longer exists. It is a dark-mode capture from before the design uplift in #903: "Start a new
channel", Bots called agents and teammates, a /barchart command to draw a chart, an approval card with
Approve and Decline, a one-row composer, and a sidebar footer reading Skills, Agents and
dev@openbot.local. Someone who clones the repository after watching it lands in an app that looks and
reads differently on every screen it showed.

It also leaves out most of what a Bot now does on its own: the work line that sums up what it did, its own
computer beside the conversation, answers as components, sends that always ask first, taking control of
its browser and handing it back, a framework agent connected from the New Bot sheet, and check-ins.

The approach

The README's video URL now points at a 45-second film of OpenBot as it is on main at v0.3.1. It follows
one person through one conversation, then comes back to it at the end:

  1. Give a Bot a job. From the home screen, ask General Assistant to open a help desk and chart last week's tickets.
  2. It works on its own computer. The Computer panel opens on the Bot's browser while the work line runs.
  3. It answers with components. The answer is a bar chart that names its source.
  4. Changes wait for you. "Send this chart to Dana" stops at "Waiting for your approval: send email on Gmail", and Allow once lets it through.
  5. Take over, then hand it back. Take control opens the full-size view of the Bot's browser. The person clicks about on the page, then Hand back.
  6. Bring the agent you already run. Bots, then New Bot, then Connect a custom agent, LangGraph, and its address.
  7. It checks in when something needs you. The Needs you card on the Bots page. Then the person clicks back into the conversation, and the film ends there.

The film is drawn, not captured. A capture needs a running Bot with a model key and a computer per
person, and the Recorder and check-ins also need connected apps. Without those, the honest capture
showed empty states. Drawing it keeps each screen deterministic and free of personal data. The cost is
that every string had to be copied, so each string in the product's own chrome was read from main at
8d0ea17d before it was drawn. That covers the composer's model button, the Screen and Terminal tabs,
"You have control. Click and type on the page.", the approval wording, and the New Bot sheet's framework
list. The story itself is fictional: a freight company's help desk at a .example address, its tickets,
and Dana.

The video carries short captions, one per step, so it reads with the sound off, which is how a README
plays it. It has no audio.

What is not covered

  • The Personal Edition download and the desktop installers are not shown.
  • Teaching a Bot by recording a task in your browser is not in this film. It deserves a video of its own.
  • The film is drawn against v0.3.1 (8d0ea17d), and two of the things it shows have changed on main since then, in Open each shared skill on its own page, and write one on a page of its own #1032. The composer's model button is now a chip icon and a chevron with no model name, where the film shows "GPT-6.1 Terra · High". The approval card now lists Allow once, Always allow here and Deny with a line explaining each, where the film shows the two buttons. If the video should match the release that ships, those two beats need re-rendering before this merges.
  • The README copy around the video is untouched. docs: clarify OpenBot setup options and link desktop installers #1025 rewrote it and merged today, and it kept the old video.

Verification

  • 44.6 s, 1920×1080 at 60 fps, 8.8 MB, under the 10 MB attachment limit. Frame 0 is the home screen, so the player's poster is not blank.
  • Every click in the film was checked to land in frame (15 of them), and a frame-by-frame review found no stalled stretch except a deliberate 2.7-second hold on the chart.
  • The camera's zoom was traced over the whole film: no zoom in and out within about two seconds, which is what the first version did around 40 seconds.
  • The rendered README on the branch draws a player for the URL, and the video loads without signing in.

The video under the README's badges still showed the product from before the design uplift: "Start a new channel", a slash command to draw a chart, Approve and Decline, and dev@openbot.local in the sidebar. It now points at a 44-second film of v0.3.1, from a first ask through the Bot's own computer, a component answer, an approval, taking control and handing back, connecting a framework agent and a check-in, then back to the conversation.
Around 40 seconds the camera pulled out as the New Bot sheet closed, pushed in to the Needs you card and pulled out again within a second and a half. It now moves from the sheet straight to the card, holds it, and pulls out once to the conversation. The sheet's framework list also stays at the same zoom as the steps around it, so nothing else in the film zooms in and out in quick succession.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant