Skip to content

HERD-38 README: short and current, user guide split out - #124

Merged
makefunstuff merged 3 commits into
mainfrom
task/38-readme-rewrite-short-current-user-guide-split-ou
Nov 8, 2026
Merged

makefunstuff merged 3 commits into
mainfrom
task/38-readme-rewrite-short-current-user-guide-split-ou

Conversation

@makefunstuff

Copy link
Copy Markdown
Owner

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

Lines Words
README.md before 389 10,816
README.md after 119 980
docs/GUIDE.md (new) 242 ~2,750
docs/ARCHITECTURE.md (new) 40 ~490
docs/RELEASING.md (new) 42 ~360

New README outline

  1. One sentence: what the app is and who it's for
  2. The gallery (same images, captions of a few words)
  3. Install (and backing up the SSH key)
  4. Set up a machine: by its code, by hand, Windows
  5. What you can do: one line per feature, each linking to the guide
  6. Building and checks (points to AGENTS.md, ARCHITECTURE.md, RELEASING.md)
  7. Layout, Contributing, License

Other changes

  • docs/GUIDE.md: the user guide, organised by what you do: Tasks and Needs you, agent chats, pictures and voice, the Assistant and the board, start work, the terminal, search, code/PR/browser/docs, machines, notifications, the brief, from outside the app, changing the app, settings and security, big screens and accessibility. Written in plain short sentences, with no internals.
  • Stale facts fixed: Health, Usage and Logins are tiles on the machine screen, not ⋯ menu items. Added Autopilot and the Assistant's chat tools (reply, react, find, hear, call). Dropped "Remove a worktree" from the guarded actions, because HERD-12 removed it.
  • docs/ARCHITECTURE.md: how the app reaches herdr, herdr-core, Shepherdr, shp, transcripts, git/gh and docs, plus the host scripts.
  • docs/RELEASING.md: the signing key, CI releases, signing a local build, and building updates on a machine.
  • tools/ui-preview/README.md: the gallery's render recipe, now a script that writes to copies.
  • host/herdr-push/README.md: the Windows section now links to the README, and the Add machine path is fixed (there is no Machines tab).
  • CONTRIBUTING.md: links point to the new anchors and docs.

Checks

  • Every relative link and anchor in every .md file 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.
  • No code changed, so no gradle checks were run.
  • HERD-37 (herdr-core start/close) has not landed. The guide says herdr-core spaces only open their panes, which is true on main today.

🤖 Generated with Claude Code

makefunstuff and others added 3 commits November 8, 2026 18:24
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>
@makefunstuff
makefunstuff merged commit 2c4ad42 into main Nov 8, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant