Repository navigation
Retake docs screenshots automatically and add 20 more - #321
Merged
Merged
Conversation
Adds `make docs-screenshots`, which seeds a separate local database, starts the web app on its own port, and saves each screen as a light and a dark WebP file for the docs site. A monthly GitHub Actions job runs it and opens a pull request into staging, and can also be started by hand. - The script lives in `web/scripts/docs-screenshots/`. Its list of screens is `shots.ts`, and the Claude desktop app screenshot stays manual and is listed there with its date. - The seed steps moved into `web/scripts/seed-workspace.ts` so `db:seed` and the screenshot run share them. - The docs site draws a browser frame around full-window screenshots and shows the light or dark image to match the reader's theme. - 20 new screenshots are placed on the pages for tokens, instruments, watchers, manual uploads, qPCR and Aunty runs, integrations, feedback, and MCP sign-in. - The README now uses the docs images. The image files themselves are not in this commit. Co-authored-by: Cursor <cursoragent@cursor.com>
Adds the 33 screenshots as light and dark WebP files, and removes the hand-taken PNGs and the README copies they replace. The mcp.png screenshot stays. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Window shots are 800px tall instead of 900px, with the run pages, qPCR, Aunty, integrations, and sign-in screens each trimmed too. Close-ups keep their size. The title bar is about 6px shorter. All screenshots are retaken. Co-authored-by: Cursor <cursoragent@cursor.com>
This branch was successfully deployed
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 this does
The docs site screenshots were taken by hand months ago. This replaces them with a script that retakes them, and adds 20 more.
make docs-screenshotsseeds a separate local database, starts the web app on its own port, and saves each screen as a light and a dark WebP file indocs/site/public/images/..github/workflows/docs-screenshots.yml, runs it on the 1st of every month and opens or updates one pull request intostaging. It can also be started from the Actions tab with Run workflow.web/scripts/docs-screenshots/shots.ts. Each entry names the page, the clicks needed, and whether it is a full window or a close-up.Screenshots
mcp.png(the Claude desktop app) cannot be captured by a script. It stays as it is and is listed underMANUAL_SHOTSwith the date it was taken. The monthly pull request lists how old it is.Docs site and README
datahub.example.com/<page>in the address bar. Close-ups have no frame.docs/site/src/lib/screenshots.generated.tsis written by the script and tells the site which images exist.<picture>tags, so GitHub shows the dark version to dark-mode readers..github/images/is removed..webpfiles.Things to know
next dev, not a production build. The local file mirror that serves the gel images, PDFs, and plate maps is turned off in production builds, so a production run would show no reports.data_hub_screenshots) and its own file mirror underweb/.docs-screenshots/, so it does not touch local data or a runningmake dev. It restoresweb/tsconfig.json,web/AGENTS.md, andweb/next-env.d.ts, whichnext devedits, and stops a leftover server from a crashed run.web/scripts/seed-workspace.tssodb:seedand the screenshot run share them.db:seedbehaves as before.stagingrequires one review and no checks.Testing
make checkpasses. Web unit tests pass (683).web/tsconfig.jsonandweb/AGENTS.mdunchanged.After merging
The workflow has not run yet, because it only runs from the default branch. After this merges, start it once with Run workflow to confirm it opens a pull request.