docs: show the UI in the readme - #47
Merged
Merged
Conversation
Adds three screenshots — the overview, a project's nested bean list, and a bean's detail view — so the readme shows what the app looks like before someone installs a Go binary and points it at their projects. Each one ships a light and a dark variant behind a <picture> element, so the shot matches the theme the reader is already viewing GitHub in. Also corrects the pnpm version the prerequisites mention, which the dependency bump to pnpm 11 left behind.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Bundle ReportBundle size has no change ✅ |
Quantizes to an 8-bit palette and squeezes losslessly, taking the six images from 1296 KB to 492 KB. Flat UI screenshots carry few enough colours that the palette is effectively lossless here; checked at full resolution that small monospace text, hairlines and badge borders are unchanged.
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.
Summary
The readme described the app but never showed it, so the only way to find out what
beans-weblooks like was to install a Go binary and point it at your projects. Adds three screenshots covering the main tour.Changes
<picture>+prefers-color-scheme, so the shot matches the theme the reader already has GitHub set toThe three shots were picked to show something the prose cannot: that beans nest by parent (a milestone expanding into epics, features and bugs), and that a bean's fields and relationships are editable inline rather than through a form.
Usage
Nothing to use — but the demo data is reproducible rather than hand-made. Screenshots were taken against a throwaway
GIT_ROOTseeded with five projects and 42 beans spread across every type, status and priority, with dates spread over eight months so the analytics series has a real shape. No real project data appears in them.How to validate
The images are worth actually looking at rather than trusting:
srcsetpath is wrong, since the<img>fallback still renders.Related links