Skip to content

docs: add TUI screenshots, walkthrough video/GIF, and copy-edit README - #123

Merged
futuregerald merged 3 commits into
mainfrom
docs/readme-visuals-and-copy-edit
Nov 14, 2026
Merged

futuregerald merged 3 commits into
mainfrom
docs/readme-visuals-and-copy-edit

Conversation

@futuregerald

Copy link
Copy Markdown
Owner

Summary

  • Applies a structured /copy-edit (copywriting + marketing-psychology) overhaul to README.md with a clear hero value proposition, a Before/After comparison table, a role-matched track decision matrix, and explicit coverage for both CLI and desktop harnesses (Claude Code, Claude Desktop, Google Antigravity, Zed Editor, and OpenCode).
  • Captures and embeds real high-DPI terminal screenshots (docs/assets/tui-*.png) plus an animated walkthrough GIF (docs/assets/tui-walkthrough.gif) and video (docs/assets/tui-walkthrough.mp4) covering every step of the interactive skill-installer wizard and skill-installer guide.
  • Fixes the CI workflow badge link (test.yaml) and aligns all non-interactive CLI flag examples (--target, --global, --project, --merge-config, --yes), Antigravity paths (~/.gemini/config/hooks/, <project>/.agents/), and merge markers (<!-- BEGIN SKILL-INSTALLER WORKFLOW RULES -->) with main.go, internal/platform, and internal/state.

Background

Users landing on the repository needed visual proof of the interactive 3-step Bubble Tea wizard (./skill-installer) and 3-tab explorer (skill-installer guide), as well as clearer guidance on why curated role-matched tracks outperform installing 50+ skills at once and how skill-installer safely merges into existing config files without clobbering user rules or desktop settings.

Test Plan

  • test -z "$(gofmt -l .)"
  • go vet ./...
  • HOME=$(mktemp -d) go test -race ./...
  • pytest (741 passed)
  • Reviewed with editor-pass-reviewer and resolved all CLI flag and path findings (A–G)

Rollback Plan

Revert this PR commit to restore the previous text-only README.md and remove docs/assets/.

@futuregerald
futuregerald merged commit a25c0e9 into main Nov 14, 2026
1 check 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