Repository navigation
docs(demo): add the README demo recording runner and procedure - #34
Merged
Merged
Conversation
Why: the README demo video must be re-recordable after UI changes. The choreography is reproducible automation (WebDriver-driven tour of a disposable demo library with visible click ripples and typed input), but window position, recorder, and WebKit quirks are machine-specific, so the procedure documents what to re-measure per machine instead of pretending the pipeline is portable. How: record-demo.py builds an isolated sandbox (own XDG dirs, fictional notes, a few 'car*' titles so the search narrows on camera), launches the debug binary via tauri-driver, and performs the tour: light theme, open note, typed search, new note (keeping the auto-created heading), fast Markdown body in Source, Preview, dark finale. recording.md walks through recorder setup, take-boundary and window-rect calibration, ffmpeg trim/crop/palette encoding, and the WebKitWebDriver quirks hit on the way. Tests: python3 docs/demo/record-demo.py completes all SCENE markers against target/debug/foglio-desktop built via tauri build --debug --no-bundle; media files intentionally left uncommitted (README embeds them via a user-attachments upload).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why: the README demo video must be re-recordable after UI changes. The choreography is reproducible automation (WebDriver-driven tour of a disposable demo library with visible click ripples and typed input), but window position, recorder, and WebKit quirks are machine-specific, so the procedure documents what to re-measure per machine instead of pretending the pipeline is portable.
How: record-demo.py builds an isolated sandbox (own XDG dirs, fictional notes, a few 'car*' titles so the search narrows on camera), launches the debug binary via tauri-driver, and performs the tour: light theme, open note, typed search, new note (keeping the auto-created heading), fast Markdown body in Source, Preview, dark finale. recording.md walks through recorder setup, take-boundary and window-rect calibration, ffmpeg trim/crop/palette encoding, and the WebKitWebDriver quirks hit on the way.
Tests: python3 docs/demo/record-demo.py completes all SCENE markers against target/debug/foglio-desktop built via tauri build --debug --no-bundle; media files intentionally left uncommitted (README embeds them via a user-attachments upload).