Repository navigation
HERD-38 README: short and current, user guide split out - #124
Merged
makefunstuff merged 3 commits intoNov 8, 2026
Merged
Conversation
README.md goes from 389 lines (10.8k words) to 119 (1k): what the app is, the gallery with short captions, Install, Set up a machine (by code, by hand, Windows), a one-line-per-feature list linking to the guide, Building and checks, Layout, Contributing, License. - docs/GUIDE.md: the user guide, by what you do, in plain short sentences. Fixes stale paths (Health, Usage and Logins are tiles on the machine screen, not ⋯ items) and adds Autopilot and the Assistant's chat tools. - docs/ARCHITECTURE.md: how the app reaches a machine (developer notes moved out of the README). - docs/RELEASING.md: release signing and building updates on a machine. - tools/ui-preview/README.md: the screenshot recipe, as a script. - herdr-push README: the Windows link and the Add machine path; CONTRIBUTING links to the new anchors. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ull shots Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
The README was a user manual, a dev guide and a changelog in one. It is now a short front page, and the details are in separate docs.
Before / after
New README outline
Other changes
Checks
.mdfile resolves. I checked this with a script that also caught a broken anchor I planted on purpose. No app or host code links to a README anchor.🤖 Generated with Claude Code