Skip to content

docs: README overhaul — demo GIF, quickstart guide, screenshots#320

Open
aramirez087 wants to merge 4 commits intomainfrom
docs/sprint-9-readme
Open

docs: README overhaul — demo GIF, quickstart guide, screenshots#320
aramirez087 wants to merge 4 commits intomainfrom
docs/sprint-9-readme

Conversation

@aramirez087
Copy link
Copy Markdown
Owner

Summary

  • Adds demo GIF showing Tuitbot in action (P1)
  • Adds quickstart guide — first reply in 5 minutes (P2)
  • README polish: social preview, screenshots, comparison table (P3)
  • Fixes demo GIF with full-frame version (800x500)

Test plan

  • Verify demo GIF renders correctly on GitHub
  • Verify quickstart guide links work
  • Visual review of README formatting

🤖 Generated with Claude Code

Finn added 4 commits March 24, 2026 20:18
53-frame walkthrough captured with Playwright + ffmpeg:
- Home / composer workspace (DraftStudioShell)
- New draft flow
- Discovery feed
- Approval queue with filters
- Analytics page

Output: assets/demo.gif (186KB, well under 5MB limit)
Embedded in README after badges.
docs/quickstart.md covers:
- Prerequisites table (X Developer App, OAuth callback, LLM key)
- Install (one-liner, cargo, binary)
- tuitbot init wizard walkthrough
- tuitbot discover output example
- tuitbot compose with approve/edit/reject flow
- tuitbot approve to post
- What's next table linking to deeper docs

README: added ⚡ Quickstart link prominently in the nav row.
- Social preview: assets/social-preview.png (1280x640, 52KB) for GitHub link cards
- Feature screenshots: discovery feed + approval queue (assets/screenshot-*.png)
- Comparison table: TuitBot vs Typefully, Hypefury, manual posting
- Choose Your Path: added Time column, 4th row for self-host, clearer persona language
- Screenshots table: 2-column responsive layout embedded in README
Previous GIF had frames 1-52 at 1x1 pixel due to ffmpeg delta optimization
on visually-identical source frames. New version uses ImageMagick convert
which emits full 800x500 frames for all 53 frames.

README.md embed was already present from commit 3b15329 (line 18).
Pages show UI chrome with empty states — no seed data available in dev
server; empty states are accurate representation of fresh install.

Verification: identify shows 53 frames all at 800x500
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