Skip to content

docs: split README into focused guides (Apple Photos, tuning, troubleshooting)#19

Merged
niranjans merged 1 commit into
mainfrom
claude/nervous-mestorf-c12891
Jun 9, 2026
Merged

docs: split README into focused guides (Apple Photos, tuning, troubleshooting)#19
niranjans merged 1 commit into
mainfrom
claude/nervous-mestorf-c12891

Conversation

@niranjans

Copy link
Copy Markdown
Contributor

What

The README had grown to 422 lines. This splits the deeper / edge-case material into docs/ sub-pages linked near the top, leaving the core workflow in the README (now 242 lines, ~43% smaller).

New sub-pages

  • docs/apple-photos.md — full Apple Photos library guide, including the iCloud "Optimize Storage" edge case (the bulk of what was trimmed).
  • docs/tuning.md — folder-context priors, proper-noun biasing, languages, speaker-diarization setup.
  • docs/troubleshooting.md — common errors and fixes.

README changes

  • New "Guides" links block near the top.
  • Apple Photos kept as a short pointer (one-command common case) + link to the full guide, so the feature stays discoverable.
  • Dropped em-dashes across the README and new docs (they crept back in after docs: promote SimbaStack in README, drop em-dashes #16).
  • Fixed a stale limitation line that said "RAW photo support not yet" — RAW is supported now (contradicted the Still photos section).

Kept prominent

  • The "Built by SimbaStack" section is untouched and stays in the README. SimbaStack also appears as a footer link on each new sub-page.

Not doing

  • No content rewrite beyond relocation + em-dash cleanup. Sections moved verbatim (semantically).
  • SKILL.md carries the same stale "RAW not yet" line; left for a separate change to keep this PR doc-scoped.

No behavior change. CHANGELOG updated under Unreleased.

🤖 Generated with Claude Code

The README had grown to 422 lines. Move deeper / edge-case topics into
docs/ and link them near the top, keeping the core workflow in the README.

- docs/apple-photos.md: full Apple Photos library guide incl. the iCloud
  "Optimize Storage" edge case (the bulk of the trimmed content)
- docs/tuning.md: folder context, proper-noun biasing, languages, diarization
- docs/troubleshooting.md: error/fix list
- README: 422 -> 242 lines; keep a short fdx-photos pointer to the new guide
- Drop em-dashes across README + new docs (re-introduced after #16)
- Fix stale "RAW photo support not yet" limitation (RAW is supported now)
- SimbaStack section kept prominent in the README

No behavior change. CHANGELOG updated under Unreleased.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@niranjans niranjans merged commit 64c7b56 into main Jun 9, 2026
1 check passed
@niranjans niranjans deleted the claude/nervous-mestorf-c12891 branch June 9, 2026 21:50
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.

2 participants