Skip to content

Add hero GIF recording scripts and README demos#173

Merged
tig merged 8 commits into
developfrom
tig/hero-gif-script
May 22, 2026
Merged

Add hero GIF recording scripts and README demos#173
tig merged 8 commits into
developfrom
tig/hero-gif-script

Conversation

@tig
Copy link
Copy Markdown
Member

@tig tig commented May 22, 2026

Summary

Adds animated GIF recordings for clet help and clet pick-file to the README, along with tuirec recording scripts for reproducibility.

Changes

  • src/Clet/Hosting/MarkdownHelpRenderer.cs: Use [alias](clet:help:alias) link syntax in help table cells (now that TG supports clickable links in tables); remove the "Click for details" workaround list
  • src/Clet/Clets/Viewer/HelpClet.cs: Add DrawComplete workaround for TG auto-scroll bug (Markdown view auto-focuses last link on initial render, scrolling to bottom Terminal.Gui#5365)
  • scripts/CLET-HELP-GIF.md: tuirec recording guide for clet help GIF
  • scripts/CLET-PICK-FILE-GIF.md: tuirec recording guide for clet pick-file GIF
  • docs/images/clet-help.gif: Animated demo showing help browser navigation
  • docs/images/clet-pick-file.gif: Animated demo showing file picker with filter
  • README.md: Add both GIFs to the Demo section

Related issues

No spec/runbook impact

tig and others added 8 commits May 22, 2026 08:48
scripts/CLET-HELP-GIF.md: tuirec recording guide demonstrating:
- Overview page with clet table and scrolling
- Tab+Enter link navigation to topic pages (select, int)
- Scrolling within markdown content (PageDown)
- Back navigation via Ctrl+Left (BrowseBar)
- Quit with Esc

docs/images/clet-help.gif: recorded output (394KB, 100x30, ~13s)

Uses keyboard-based link navigation (Tab cycles links, Enter follows)
because mouse click detection for OSC 8 hyperlinks is unreliable
under tuirec's terminal emulation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- MarkdownHelpRenderer: Use [alias](clet:help:alias) link syntax in table
  cells instead of backtick code spans; remove 'Click for details' hack
- HelpClet: Add DrawComplete workaround for TG auto-scroll bug (#5365)
- Re-record clet-help.gif with mouse clicks on table links, CursorDown
  scrolling, and faster pacing (keystroke-delay 50)
- Update CLET-HELP-GIF.md to document click-based navigation approach

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ck, quit

New sequence: PageDown×4 to bottom, PageUp×4 back to top, click select
link, view select help, Ctrl+CursorLeft back to overview, Esc quit.
keystroke-delay 80 for readable scrolling pace (~9s total).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Script: Tab×3 to filter field, type 'rea', Shift+Tab back to table,
'r' to jump-select README.md, Enter to accept. ~9s at keystroke-delay 80.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
True inline rendering (app below prompt) requires tuirec support for
TG AppModel.Inline — filed as gui-cs/tuirec#49. For now, 80×20 gives
a smaller, more compact appearance.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Script: start with -i #00cc00, CursorRight×12 on H slider to sweep
through the spectrum, Tab to S slider + CursorLeft×3, Enter to accept.
~8.5s at keystroke-delay 70.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Temporarily activates Anders theme in ~/.tui/clet.config.json before
recording, then restores. The GIF now shows the blue Anders theme
background, replacing the static screenshot in the Theming FAQ.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@tig tig merged commit 28c2f50 into develop May 22, 2026
10 checks passed
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