Repository navigation
docs(timeline): add a screen-recording demo at the top of the Timeline plugin docs #350
Closed as not planned
Description
Problem
@flybot/timeline shipped (#241, #246, #247) and is opt-in and hidden by default (#281, #282). #329 re-recorded the README demos for tree, social and face-to-face, but removed timeline-swimlanes.png, so Timeline now has no visual at all. A new reader cannot tell what it does or why they would turn it on.
Ask
Add a short screen recording at the top of the Timeline docs, before any text explanation, in the same style as the other demos.
- Placement: top of
plugins/timeline/README.md, and also inREADME.zh.md/README.mdwhere Timeline is mentioned (text-only today). - Format: same as docs(readme): re-record every demo on the current UI #329: GIF preview + MP4, 1280x720 source, each MP4 under 1 MB, stored in
docs/images/(e.g.demo-timeline.gif/.mp4). - Length: about 30-45 s.
Suggested storyline
- Enable the plugin explicitly (it is off by default), so the opt-in step is visible.
- Run a multi-bot turn (e.g. the tree: Chief delegates to Travel / Food / Budget).
- Open the Timeline: swimlanes of Bot turns and tool runs, the who-waits-on-whom map, utilization, and the window's time range.
- Show one waiting-for-approval moment so the approval lane is visible.
Recording and content rules
- Record on the current UI of main, throwaway homes, headless browser with its own profile (as in docs(readme): re-record every demo on the current UI #329); no real tokens, invite links, URL bars or personal Bot names in any frame.
- Caption the key moments briefly so it reads with sound off.
- Add a one-line note on top of the README that Timeline is opt-in, and how to turn it on.
Acceptance
- Recording appears first in
plugins/timeline/README.mdand renders on GitHub (GIF inline, MP4 linked). - Each MP4 under 1 MB; no secrets visible (check frames).
README.mdandREADME.zh.mdreference the same media.- Docs verify passes.
Process
Per team rule, recording and docs changes go through cloud OpenCode, review via Codex; bots do not hand-write code.
Activity
Birfy commentedon Oct 18, 2026
Maintenance note (2026-10-18 22:20 Asia/Shanghai): the owner's current decision is that Timeline stays text-only: it is hidden by default, not loaded anywhere in the UI, and gets no demo video (every other README feature does). So a screen recording for the Timeline docs is not wanted right now. Leaving this open for the owner to confirm or close; nobody should start on it until then.
Birfy commentedon Oct 18, 2026
Closing as not planned: my decision is that Timeline stays text-only for now (opt-in, hidden by default, no demo video), while every other README feature gets one. The README already explains it in text with two still images. Reopen if Timeline becomes a visible default feature.