Repository navigation
docs: lead the README with dashboard screenshots and move reference tables to docs/ - #85
Merged
darkzOGx merged 2 commits intoOct 27, 2026
Conversation
…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>
5 tasks done
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.
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,
.envessentials, and vendor acknowledgments to a newdocs/providers.md; the full troubleshooting table todocs/troubleshooting.md(the README keeps the top three rows); project structure and the extending guide toCONTRIBUTING.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:screenshotsscript (scripts/docs/capture-screenshots.js) that starts the dashboard from the checkout, opens it in Playwright Chromium at 1440x900, and saves PNGs toassets/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.--livecaptures 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-a8605aso the screenshots show the cleaned-up console (no aurora, glow, or doubled nav labels). The PR targets that branch and GitHub will retarget it tomasteronce #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
package-lock.jsonregeneration unless the PR is specifically about dependenciesnpm run lintpassesnpm testpasses (add a test if you fixed a bug)master(via fix(dashboard): remove ambient motion, fix doubled nav labels, read version from server #84, which is itself on currentmaster)How I tested it
npm run lintclean;npm test49 passed, 0 failed.npm run docs:screenshotsend 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.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 atdocs/providers.md#video.git check-ignoreconfirmed the PNGs were being excluded by the repo's*.pngrule, so.gitignoregains!assets/screenshots/*.png.🤖 Generated with Claude Code