Add tuirec recording guide and hero-gif docs#5396
Open
tig wants to merge 10 commits into
Open
Conversation
Add hero-gif.md as a minimal pointer to the recording guide. Add Scripts/tuirec.md with the full recording workflow, validation checklist, agent guidance, and TBD sections for UICatalog scenarios, EnableForDesign views, and standalone example apps. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Rewrote Scripts/tuirec.md with comprehensive agent-oriented guidance for recording UICatalog scenarios using gui-cs/tuirec - Includes install steps, keystroke composition, PowerShell quoting, --kitty-keyboard decision tree, troubleshooting, and validation checklist - Added working CharMap scenario recording (docfx/images/charmap.gif) - Updated hero-gif.md with quick-reference recording command Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Corrected the framing: this is a tuirec encoding bug (sends fabricated CSI u codepoints for nav keys), not a Terminal.Gui parsing issue. Filed gui-cs/tuirec#54 with full spec analysis. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
tig
added a commit
that referenced
this pull request
May 24, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
Author
|
Superseded by PR #5393 which consolidates all Spectre interop work. |
Re-recorded with a focused demo script that: - Scrolls briefly to show charmap responsiveness - Uses CollectionNavigator typing to jump to Box Drawing category - Jumps to Emojis Symbols category to show emoji rendering - Opens context menu (Shift+F10) on a glyph - Updates tuirec.md example to document these techniques Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
Author
Feedback from using tuirec guidance to record SpectreView scenarioThe recording succeeded first try using For "Recording UICatalog Scenarios" section:
For "Recording Individual View Sub-classes with EnableForDesign":
For "Recording Standalone Example Apps":
|
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Re-record using Box Drawing + Arrows instead of Emojis (wide glyphs cause misaligned rendering in agg output) - Add 'Avoid wide glyphs' principle to recording guidance - Add 'Output File Placement' section: GIFs go alongside scenario code at Examples/UICatalog/Scenarios/<Dir>/<Name>.gif - Add wide-glyph troubleshooting entry - Use PascalCase --name matching the scenario class name Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Move Scripts/tuirec.md -> Scripts/tuirec/README.md - Move hero-gif.md -> Scripts/tuirec/hero-gif.md - Update file placement guidance: GIFs and optional *-tuirec.ps1 scripts live alongside the .cs file they document - Fix quit key: Escape is the default (not Ctrl+Q) - Add guidance for View-derived class GIF placement Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Agents should follow the general workflow in README.md rather than creating per-scenario tuirec scripts. If something is unclear enough that an agent creates a bespoke script, the README should be improved. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
New sequence: Tab to category list, A (Arrows), Bo (Box Drawing), E (Emoji), Tab back to grid, context menu, quit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sequence: Tab to categories, Arrows -> Box Drawing -> Emoji, Tab back to grid, context menu, quit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Process documentation for capturing GIFs/recordings of Terminal.Gui apps and scenarios.
Changes
hero-gif.md— minimal root-level pointer to the recording guideScripts/tuirec.md— comprehensive recording guide covering:These docs support the hero-GIF workflow discussed in #5393.