Repository navigation
Redesign the README: header, hero image, scannable features - #25
Merged
Merged
Conversation
- Centered header: logo, tagline, link row (website, quick start, changelog, discussions, bug report), and release / Docker pulls / arch / build / license badges. - One composed hero image (docs/screenshots/readme-hero.png) instead of three raw screenshots side by side. - Feature list rewritten as scannable emoji bullets, leading with the paint catalog and barcode scanning. - Environment variable table collapsed behind <details>; Tech stack folded into Local development; star call-to-action at the end. - Drop screenshot crops nothing references any more.
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.
This gives the README the layout popular self-hosted projects use (Homebox, Linkwarden, Immich and Mealie all lead this way): a centered identity block, a link row, a few badges, then one polished hero image.
Stacked on #24. It uses #24's
docs/screenshots/paths. Merge #24 first, and GitHub will retarget this PR tomain.What changed
docker-publish.ymlonmain, becauseci.ymlonly runs on PRs.docs/screenshots/readme-hero.png(1600×780). The three phones show the dashboard, the completed HMS Victory build and the model catalog. It replaces the three raw screenshots that sat side by side. I avoided the tall build screenshot because it shows a build marked "Planned" at 100% (the Changing Progress Resets to Planned #14 bug).<details>toggle ("Nothing is required" stays visible), Tech stack is folded into Local development, and there's a star call-to-action at the end.readme-mobile-build.pngstays as the source for the hero.Deliberately left out until they exist: a live demo link and a PikaPods button.
Checks
markdownmode, the same as the repo page) with images pointed at this branch. The link row and badges each stay on one line, and the hero renders full width.npm run fmt:checkpasses.main.