Skip to content

docs: lead the README with dashboard screenshots and move reference tables to docs/ - #85

Merged
darkzOGx merged 2 commits into
claude/youtube-agent-ui-ux-review-a8605afrom
claude/ecstatic-hodgkin-a7218b
Oct 27, 2026
Merged

darkzOGx merged 2 commits into
claude/youtube-agent-ui-ux-review-a8605afrom
claude/ecstatic-hodgkin-a7218b

Conversation

@darkzOGx

Copy link
Copy Markdown
Owner

What & why

The README was a 313-line document that opened with text and never showed the product. This PR puts three dashboard screenshots directly under the badges and trims the file to 174 lines by moving reference material where it belongs: the provider tables, narration/image notes, video matrix, .env essentials, and vendor acknowledgments to a new docs/providers.md; the full troubleshooting table to docs/troubleshooting.md (the README keeps the top three rows); project structure and the extending guide to CONTRIBUTING.md. A new Docs section links all of them. It also drops the hand-dated "Latest release" line (replaced by a release badge), the launch-gate HTML comment, the mermaid graph that duplicated the stage table, and the unreferenced mascot JPEG.

The screenshots come from a new npm run docs:screenshots script (scripts/docs/capture-screenshots.js) that starts the dashboard from the checkout, opens it in Playwright Chromium at 1440x900, and saves PNGs to assets/screenshots/. By default it injects sample records into the dashboard's in-browser state so every panel is populated; the database is never written, and the README caption says the images use sample data. --live captures the local database as is. Re-run it after any visible dashboard change.

Stacked on #84. This branch is cut from claude/youtube-agent-ui-ux-review-a8605a so the screenshots show the cleaned-up console (no aurora, glow, or doubled nav labels). The PR targets that branch and GitHub will retarget it to master once #84 merges; merge #84 first.

After merging: set the repository's social preview (Settings → General → Social preview) to assets/screenshots/overview.png, which replaces the deleted mascot image.

Checklist

How I tested it

  • npm run lint clean; npm test 49 passed, 0 failed.
  • Ran npm run docs:screenshots end to end in this worktree: the server started in setup mode on a free port, all three PNGs were written (347 KB, 366 KB, 244 KB), and the server was stopped afterward. Opened each image and checked the content.
  • Ran a link checker over README, CONTRIBUTING, and every file in docs/: all 56 relative links and heading anchors resolve. The one external reference into a moved README section (docs/features.md → README.md#video) now points at docs/providers.md#video.
  • git check-ignore confirmed the PNGs were being excluded by the repo's *.png rule, so .gitignore gains !assets/screenshots/*.png.

🤖 Generated with Claude Code

darkzOGx and others added 2 commits October 26, 2026 19:38
…enshots

`npm run docs:screenshots` starts the dashboard from the checkout on a free
port, opens it in Chromium at 1440x900, and writes overview.png, operator.png,
and review.png to assets/screenshots/. By default it injects sample records
into the dashboard's in-browser state so every panel is populated; the
database is never written. `--live` captures whatever the local database
holds instead. The .gitignore gains an exception so these PNGs are tracked.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ables to docs/

README goes from 313 to 174 lines and opens with three screenshots of the
operator console right under the badges. The provider tables, narration and
image notes, video matrix, .env essentials, and vendor acknowledgments move
to docs/providers.md; the full troubleshooting table moves to
docs/troubleshooting.md (the README keeps the top three rows); project
structure and the extending guide move to CONTRIBUTING.md. A Docs section
links all of them. Also drops the dated "Latest release" line in favor of a
release badge, the launch-gate HTML comment, the mermaid graph that
duplicated the stage table, and the unreferenced mascot JPEG.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@darkzOGx
darkzOGx merged commit c4f2127 into claude/youtube-agent-ui-ux-review-a8605a Oct 27, 2026
@darkzOGx
darkzOGx deleted the claude/ecstatic-hodgkin-a7218b branch October 27, 2026 00:50
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