Skip to content

docs: audit for accuracy + README purpose/process/developer notes #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kbennett2000 merged 1 commit into from
Jun 10, 2026
Merged

docs: audit for accuracy + README purpose/process/developer notes #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions AI_POLICY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# AI Policy

## Tools Used
- Junie by JetBrains / Claude (architecture, implementation, code review, CI/CD setup)
- JetBrains AI Assistant (code completion)
- **Claude Code (Claude Opus)** — this fork's songbird-import workflow was built slice-by-slice with
Claude Code under a plan-first, one-PR-per-slice process, each PR human-reviewed before merge.
- (Upstream MakeACopy additionally used Junie by JetBrains and the JetBrains AI Assistant.)

## How AI Is Used
AI tools are used as a significant development partner in this project,
Expand Down
9 changes: 5 additions & 4 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,11 @@ The full workflow is now live end-to-end (no TEMP anything): scan front/back →
`SpanResolver` re-resolve blocking on out-of-range, + title/date/tags) → **finalize screen**
(`ui/finalize/FinalizeFragment`). Finalize shows the byte-stable JSON (`emit/ImportJsonEmitter`, Appendix A;
body via `emit/NoteMarkdown`; golden `app/src/test/resources/emit/golden_import.json` governs the wire
format — update consciously), then **Send to songbird** (`POST {base}/api/v1/import`, Bearer token,
result shows created/skipped) or **Share JSON** (FileProvider, cache). Connection settings live in
`ui/settings/SettingsFragment` (base URL + token via the encrypted `songbird/SongbirdPrefsHelper`), reached
from finalize. The `SermonDraft` flows via the activity-scoped `SermonDraftViewModel`.
format — update consciously), then **Send to songbird** (cookie-session login-per-send →
`POST {base}/api/v1/import`; result shows created/skipped/failed — see the Environment errata) or
**Share JSON** (FileProvider, cache). Connection settings live in `ui/settings/SettingsFragment` (base URL
+ **username + password** via the encrypted `songbird/SongbirdPrefsHelper`), reached from finalize. The
`SermonDraft` flows via the activity-scoped `SermonDraftViewModel`.

## Combined OCR text contract (F2 — the downstream artifact)

Expand Down
6 changes: 3 additions & 3 deletions CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Our Commitment

We are committed to providing a welcoming and inspiring community for all. We pledge that everyone participating in the MakeACopy project and its communities will be treated with respect and dignity.
We are committed to providing a welcoming and inspiring community for all. We pledge that everyone participating in the Sermon Scanner project and its communities will be treated with respect and dignity.

## Our Standards

Expand Down Expand Up @@ -33,7 +33,7 @@ This Code of Conduct applies to:
- GitHub issues, pull requests, and discussions
- Project communication channels (if any)
- Community events and meetings
- Any other spaces that represent the MakeACopy project or community
- Any other spaces that represent the Sermon Scanner project or community

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Expand Down Expand Up @@ -77,5 +77,5 @@ If you have questions about this Code of Conduct, please reach out to the projec

---

**Thank you for helping make MakeACopy a welcoming and inclusive community!**
**Thank you for helping make Sermon Scanner a welcoming and inclusive community!**

Loading
Loading