docs: audit for accuracy + README purpose/process/developer notes - #18
Merged
Conversation
Accuracy fixes: - README: stale "bearer token" → username/password (songbird is cookie-session); add purpose (Majestic View Church → songbird), a How-it-works process, expand the fork note (custom-tailored to MV's notes format), and a "Developer notes — adapting to other note formats" section (AnchorFinder/BookMap/NoteMarkdown/ verse-count table/songbird emit+auth pointers). - CLAUDE.md: fix the one LIVE workflow line that still said "Bearer token / token" → cookie-session login + username/password (historical slice rows untouched). - SECURITY.md: the "completely offline" claim is false post-F6 — rewrite to on-device OCR + LAN-only operator-initiated songbird POST (encrypted creds, cleartext-for-LAN); advisory URL → this fork; releases → sideloaded debug from main (drop upstream signing key / store channels); de-brand. - CONTRIBUTING.md: slim, fork-accurate rewrite (drop removed FEATURE_SCAN_LIBRARY/ INBOX, wrong testDebugUnitTest; point to CLAUDE.md build recipe; real gate compile+test+lint + spotless; frozen-core + plan-first methodology). Light rebrand: AI_POLICY (Tools Used → Claude Code), CODE_OF_CONDUCT, accessibility guides (name + drop dead website-FAQ links). Delete MakeACopy site/store assets (not a store app): docs/index*.html, privacy*.html, og/makeacopy-1200x630.png. docs/BUILD-BRIEF.md (founding spec), LICENSE, NOTICE untouched. Docs-only — no app/src or gradle changed. Co-Authored-By: Claude Opus 4.8 (1M context) <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
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.
Docs audit + README purpose / process / developer notes
A full pass for accuracy now that the app is complete (F0–F6b + icon), plus the requested README context. Docs-only — no
app/src/gradle touched, so the build is unaffected.Accuracy fixes
AnchorFinder,BookMap,NoteMarkdown, the verse-count generator,ImportJsonEmitter/HttpImportPoster).EncryptedSharedPreferences, cleartext-permitted-for-LAN. Also fixed the security-advisory URL to this fork, replaced the upstream signing-key / Play-F-Droid release blocks with "sideloaded debug frommain," and de-branded.FEATURE_SCAN_LIBRARY/FEATURE_INBOX_MODE, the non-existenttestDebugUnitTest,git clone makeacopy, store/F-Droid bits) with a slim fork doc that points at CLAUDE.md's authoritative build recipe and states the real gate (compile + testPaddleDebugUnitTest + lintPaddleDebug+ spotless), the frozen-core rule, and the plan-first / one-PR-per-slice methodology.Light rebrand
AI_POLICY.md("Tools Used" → Claude Code/Opus, this fork's reality),CODE_OF_CONDUCT.md, and the threedocs/accessibility_mode_guide_*(name + removed dead links to the deleted website FAQ).Deleted (private non-store fork)
MakeACopy site/store + privacy pages and the OG image:
docs/index*.html,docs/privacy*.html,docs/og/makeacopy-1200x630.png.Left untouched
docs/BUILD-BRIEF.md(the founding spec — CLAUDE.md's errata already supersedes its §4),LICENSE,NOTICE.Verification
git diff --stat main= root*.md+docs/only (noapp/src, no gradle) → build/lint trivially unaffected. 16 files, +143/−2382.grepconfirms no remaining false "completely offline" / live "bearer token" claims; no dangling references to the deleted site files; README contains all four requested pieces.Docs-only, no on-device gate.
🤖 Generated with Claude Code