docs: start USER-GUIDE.md — scaffold + Reading & Annotating#109
Merged
Conversation
Begin the user's guide that picks up after the README's install: a single page with a full table of contents, the first three sections written (Getting started, Reading, Annotating) and each illustrated with the screenshots landed in PR #108. Sections 4–8 are TOC stubs for later slices; README trim is deferred to its own slice. Docs-only — gates unaffected. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This was referenced Jun 9, 2026
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
1 participant
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 landed
The first slice of the actual user's guide: a new
docs/USER-GUIDE.md— a single scrollable page with a table of contents that picks up after install (which stays in the README) and walks the new owner through using songbird, illustrated with the screenshots landed in #108.Written this slice (each opens with its screenshot, then the explanation):
welcome.png) — the owner/account model and that each person's notes are private; the verse of the day; "pick up where you left off"; recent notes.reader.png,reader-dark.png,translator-notes.png) — Book/Chapter/Prev/Next/Jump navigation; switching translations and the anchored-note invariant (a note follows the verse, not the wording); inline section headings; the conditional translator's notes; light/dark.note-editor.png,sermon.png,sermon-chooser.png) — rich-text notes (bold/italics/links/lists); tags; sermons, the ▶ marker, and the multi-sermon chooser.Sections 4–8 are TOC stubs (
## Heading+ "(Coming soon.)") so the page structure is whole and every TOC link resolves now. The README trim and those sections are later slices.Voice / accuracy
Written to CLAUDE.md's documentation rules — one real reader (the non-coding owner who just signed in), show-the-win-before-the-explanation, jargon glossed on first use. Translator's notes are stated as conditional ("the standard setup includes none, so most readers won't see them") and met gently, never via a break-to-test.
welcome.pngis the older reused shot, so its prose describes only its content, not its top-nav. Every claim was checked against the actual PNG.How it was verified
docs/(guide-relativescreenshots/<file>.png); the README "Get it running" link target exists; every TOC anchor matches a heading.make check241 passed / 4 deselected;make check-frontend221 passed, build clean.🤖 Generated with Claude Code