Skip to content

Latest commit

 

History

History
207 lines (181 loc) · 22.2 KB

README.md

File metadata and controls

207 lines (181 loc) · 22.2 KB

Specifications

One file per issue, named <issue>-<slug>.md. The issue body summarises and links here; the file is what the orchestrator's agents execute. Product-wide decisions live in ../adr/.

Phase 1 — validate the core technical risk

Issue Spec Depends on
#1 Core contracts —
#2 Fixture app —
#3 Engine #1, #2
#4 Renderer spike — the owner chose the FFmpeg compositor (ADR-0005) #3
#24 FFmpeg compositor only —
#5 CLI run #3, #4
#6 OS matrix #5

Before Phase 4

Issue Spec Depends on
#25 Real font rendering #24
#17 Source video at device pixels —
#18 Masked field visibility #31
#31 Process exits after a run —
#19 Clock sync mark #18
#47 Restore viewport-sized recording — supersedes spec 17's premise —
#42 Masked fill failure still masks #47
#44 Stable real-run tests on CI #47
#48 Sync mark: always recorded, unbiased #42, #44
#56 Container scroll settles (macOS) —
#40 Screencast stalls: re-measure, un-quarantine —
#62 Drift reference on the page clock #40
#64 Sync mark hold invariant —

Phase 3 — MCP integration

Issue Spec Depends on
#68 Generate, poll and cancel a demo —
#69 Validate scenarios, list demos, check the project #68
#75 Publish to npm through Woodpecker #68, #69
#79 demoflow record #75
#90 run starts the app from devCommand —
#92 MCP: terminal only after cleanup —
#91 A press step #85
#103 record: no extra step on a slow runner —
#105 npx demoflow inside the monorepo —
#225 MCP: the run's page URL in get_task and list_demos — vision §3.3, deferred to after Phase 5 —

Before Phase 4 (roadmap)

Issue Spec Depends on
#73 Visual baselines —

Phase 4 — Video quality

Issue Spec Depends on
#82 Spike: CDP capture at device pixels — rejected —
#85 Spike: pipelined screenshots or a zoomed large viewport #82
#100 The page in a rounded window on a background #91
#108 Intro, scene and outro cards #100
#114 Fade transitions #108
#133 GIF and WebM export —

Phase 5 — Website and Runner pairing

Issue Spec Depends on
#120 Accounts API —
#121 i18n dictionary —
#124 Sign-in pages #120, #121
#126 GitHub sign-in #120, #124
#135 Runner pairing, slice 1 #133 (cli slot)
#137 Public landing page —
#151 Runner daemon and live connection #135

Phase 2 onwards is specified now that the renderer spike has decided the renderer.

Camera

Issue Spec Depends on
#163 Zoom set per step, no automatic zoom —
#165 Scenario data and repeat #163
#173 Mask timing test flakes on macOS —
#218 waitForReady timing test flakes on macOS —
#219 Runner log rotation test flakes on Windows —
#242 Woodpecker test-pr runs out of memory when every package is affected — blocks #241 —

Phase 4–5 remainder

Issue Spec Depends on
#150 Real-run hold test flake —
#176 Vertical 9:16 export —
#236 Vertical GIF and WebM export — spec 176 follow-up —
#177 Delete my account —
#178 Projects and the demo library —
#179 Documentation section —

Phase 6 — Playback through the relay

Issue Spec Depends on
#191 Video relay (API) and its protocol —
#192 The runner daemon streams a reported run's video #191 (merge order)
#193 Run page and the VideoPlayer adapter #191
#233 Delete a run's artifacts on its machine (API) and its protocol —
#234 The runner daemon deletes a reported run's artifacts #233 (merge order)
#235 Delete a run's video files from the run page #233
#247 Start and cancel a run from the website (API) and its protocol —
#248 The runner daemon starts and cancels a run the website asked for #247 (merge order)
#249 Run a scenario from the project page #247

Phase 7 — Optional SDK

The page-side contract is ADR-0013, extended for annotations by ADR-0014. Reuse of Playwright tests is ADR-0015, from the #202 spike report.

Issue Spec Depends on
#197 data-demoflow-mask masks a marked element —
#221 A marked element drawn unblurred on one frame —
#198 window.demoflow.ready(name) and waitForReady #197 (merge order)
#201 Scenes and captions from the page #198
#202 Spike: reuse Playwright tests as scenarios —
#203 Docs: the Application SDK page #197, #198, #201
#208 demoflow/playwright: a fixture that records a scenario —
#209 Fixture: container scrolls, caption and scene helpers #208
#210 Docs: reuse Playwright tests #208; after #209; not beside #203
#224 A "Wait for ready" control in the record panel — spec 198 follow-up —

Gaps against the sources (after Phase 7)

Work traced to an ADR, the vision or spec 179 that no phase had picked up.

Issue Spec Depends on
#254 Docs: the vertical formats and render.vertical — specs 176 and 236 left the docs out —
#255 demoflow render: render an existing run again — ADR-0004, vision §12 —
#256 The /app overview: recent projects and machines — vision §6 —
#257 Filter a project's run library by status — vision §6 —
#263 Store and return a run's stage statuses, renders and failure message (API) — vision §6, ADR-0008 §2 —
#264 The run report sends stage statuses, renders and a redacted failure message #263 (merge order)
#265 Show a run's stages, files and failure message on the run page #263
#266 demoflow list and demoflow check — vision §3.4 —
#272 Docs: demoflow list and check, and what the run report sends — spec 266 follow-up —
#273 demoflow init: write a config and a first scenario — vision §3.4 #272 (merge order)
#279 Docs: starting, cancelling and deleting runs from the website — specs 235, 247-249 follow-up —
#280 Delete a run's metadata (API) — specs 233/235 follow-up —
#281 Delete a run from the run page #280
#282 Run a scenario again from the run page — spec 249 follow-up —
#283 demoflow runs: list, delete and prune local runs — spec 234 follow-up —
#284 Re-sync a running launch after the runner reconnects (API) — spec 247 Decision 7 —
#285 The daemon re-announces running launches after a reconnect #284
#286 Delete several runs at once from the project library #280, #281
#299 Download a run's video through the relay (API) — spec 191 follow-up, ADR-0009 —
#300 Download a run's video from the run page #299
#301 Live progress of a website-started run (API) — specs 247-249 follow-up —
#302 The daemon sends the live progress of a website-started run #301, #285
#303 Show the live progress of a website-started run #301
#304 Square 1:1 export — specs 176/236 follow-up —
#305 Record a scenario as a phone — specs 176/236 follow-up —
#306 Vertical and square crops follow up and down on a tall source #304
#307 No mouse cursor on a phone recording, taps only #305
#308 Docs: square formats, render.square and phone recording #304-#307
#315 Woodpecker test-pr still runs out of memory when every package is affected — spec 242 follow-up —
#325 Run options (output formats) for a website-started run (API) — ADR-0017 —
#326 The daemon accepts output formats for a website-started run — ADR-0017 #325
#327 Choose output formats when starting a run from the website — ADR-0017 #325
#329 scenarios.list truncation test times out on the Windows runner —
#288 Luna Player VideoPlayer adapter — ADR-0009 §2, Phase 6 luna-player 0.2.0
#337 ${PORT} templating, --port and --fresh-app for parallel runs — Nautelle ADR-0090 —
#347 Share a run's video: the Share model, disk storage, upload through the runner socket — ADR-0019, Phase 8 —
#348 Public share endpoints: page data, file, poster, password, views, expiry — ADR-0019, Phase 8 #347
#349 The runner uploads a render for a share; demoflow share and the MCP share_demo tool — ADR-0019, Phase 8 #347
#350 Share dialog on the run page and the /app/shares list — ADR-0019, Phase 8 #347
#351 Public share page /s/[token]: player, chapters, download, password — ADR-0019, Phase 8 #348
#352 Docs: sharing a video — ADR-0019, Phase 8 #349, #350, #351
#353 edits.json: captions, zoom, cards and style applied at render — ADR-0020, Phase 8 —
#354 Trim and cut segments from edits.json — ADR-0020, Phase 8 #353
#355 The Runner serves and saves a run's edits, re-renders on request, and exports patches — ADR-0020, Phase 8 #353
#356 Editor relay (API): edit model, save, re-render, progress, update a share — ADR-0020, Phase 8 #347, #355
#357 Timeline editor with an in-browser preview on the run page — ADR-0020, Phase 8 #356
#358 Export edits to the scenario and the config, reset edits, update the share — ADR-0020, Phase 8 #350, #357
#359 Docs: editing a video on the website — ADR-0020, Phase 8 #353, #358
#360 demoflow run --check: run and verify without recording or rendering — ADR-0021, Phase 8 —
#361 schedule in demoflow.config.json: the runner daemon runs check passes on a schedule — ADR-0021, Phase 8 #360
#362 Check schedules in the API: scheduler, check passes started from the website, stale state — ADR-0021, Phase 8 #360
#363 Check schedules on the project page, and stale badges — ADR-0021, Phase 8 #362
#364 Website docs: scheduled checks and stale demos — ADR-0021, Phase 8 #361, #363
#365 Hold the result on screen — Phase 8 —
#373 Glass UI app shell: sidebar, breadcrumbs, account menu, light and dark theme, Overview — Glass UI, vision §9 —
#374 Glass UI for projects, runs, the run page and machines — Glass UI, vision §9 #373
#375 Glass UI for sign-in, sign-up, password reset, device approval and account settings — Glass UI, vision §9 #373
#376 Glass UI polish for the landing page and the docs — Glass UI, vision §9 #373
#377 The Runner inspects, initialises and registers a folder the website names, inside allowed roots — ADR-0022 —
#378 Add a project from the website (API): machine, local path, GitHub link — ADR-0022 #377
#379 Add project dialog: machine, path, inspection result, create config, GitHub link — ADR-0022 #374, #378
#380 Docs: adding a project from the website, and allowed roots — ADR-0022 #377, #378, #379