Skip to content

docs: refresh README to the finished app; drop orphaned inbox guides - #15

Merged
kbennett2000 merged 1 commit into
mainfrom
docs/readme-current-state
Jun 10, 2026
Merged

docs: refresh README to the finished app; drop orphaned inbox guides#15
kbennett2000 merged 1 commit into
mainfrom
docs/readme-current-state

Conversation

@kbennett2000

Copy link
Copy Markdown
Owner

docs: refresh README to the finished app

Now that F0–F6 are merged (the full scan → edit → finalize flow is live), the repo's front-door doc was stale.

README.md

  • Status no longer claims the edit screen, anchor detector, JSON emitter, and finalize step "are not built yet" / that the app "terminates at the OCR result screen." Rewritten into:
    • a Workflow summary: snap front → crop → OCR → snap back → crop → OCR → concatenate → auto-detect Scripture anchor → edit screen → finalize.
    • bullets for anchor auto-detection (66-book USFM map), the edit screen (anchor/title/date/tags, live passage label, out-of-range blocks), and finalize (Send to songbird POST /api/v1/import with created/skipped; Share JSON; offline verse-count span fill; no runtime Bible API).
    • a First run note: set the songbird base URL + bearer token in Settings (encrypted) before Send is enabled.
  • Intro, fork/licensing, and Building (→ CLAUDE.md) sections kept.

Removed orphaned docs

Deleted docs/inbox_mode_guide_{en,de,fr}.md — they document MakeACopy's Inbox Mode, removed in F1c-2. No inbox code remains and nothing in the repo links to them.

Out of scope (intentionally unchanged)

  • docs/BUILD-BRIEF.md — the authoritative spec/contract.
  • docs/accessibility_mode_guide_* — the a11y-guidance capability still exists in the frozen camera path.
  • docs/index*.html, privacy*.html, og/ — upstream MakeACopy site/privacy pages (any link from them to the deleted inbox guides is a pre-existing, unmaintained dangling link; not chased).
  • LICENSE / NOTICE — preserved verbatim.

Verification

Docs-only: git diff --stat main = README.md modified + 3 inbox-guide deletions, no source/build files touched (build + frozen core trivially unaffected).

🤖 Generated with Claude Code

README Status no longer says the edit screen / anchor detector / JSON emitter /
finalize step are unbuilt — the full F0–F6 flow is live. Rewrites Status into a
Workflow + First-run/settings summary (scan → edit → finalize: Send to songbird /
Share JSON; anchor auto-detect; offline verse-count span fill; encrypted token).
Intro, fork/licensing, and Building sections kept.

Delete docs/inbox_mode_guide_{en,de,fr}.md — they document MakeACopy's Inbox Mode,
removed in F1c-2 (no inbox code remains; no in-repo references).

Out of scope (unchanged): docs/BUILD-BRIEF.md (authoritative spec),
docs/accessibility_mode_guide_* (a11y capability still present in the frozen camera
path), docs/*.html + og/ (upstream site pages), LICENSE/NOTICE.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@kbennett2000
kbennett2000 merged commit 9fb00e4 into main Jun 10, 2026
2 of 3 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