Skip to content

docs: update documentation to match current codebase#73

Merged
pasrom merged 1 commit intomainfrom
docs/auto-update-2026-03-27
Apr 2, 2026
Merged

docs: update documentation to match current codebase#73
pasrom merged 1 commit intomainfrom
docs/auto-update-2026-03-27

Conversation

@pasrom
Copy link
Copy Markdown
Owner

@pasrom pasrom commented Mar 27, 2026

Summary

  • CLAUDE.md: Added missing Tests/ directory entry for tools/audiotap/ — the MicRestartPolicyTests.swift file exists in the repo but was not listed in the project structure
  • docs/architecture-macos.md: Updated audio capture and processing descriptions to reflect actual mono/stereo channel handling introduced in 2df1e8cAudioCaptureResult now carries actualChannels, and the downmix step no longer assumes stereo input (fixes Mickey Mouse audio on mono USB headsets like Jabra PRO 930)

What was checked

  • All source files in app/MeetingTranscriber/Sources/ and tools/audiotap/Sources/ — match docs
  • All scripts in scripts/ — match docs
  • All CI workflows in .github/workflows/ — match docs
  • Package.swift dependencies — match docs
  • README.md and CONTRIBUTING.md — accurate, no changes needed

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 27, 2026
@pasrom pasrom force-pushed the docs/auto-update-2026-03-27 branch 2 times, most recently from 44ff515 to a55f3f7 Compare April 2, 2026 16:29
Copy link
Copy Markdown
Owner Author

pasrom commented Apr 2, 2026

Updated with one additional change:

CLAUDE.md — Build Variants test count: The hardcoded 618 / ~604 (14 CLI tests excluded) was stale. There are now ~795 test functions (after adding FluidVAD tests, SortformerDiarizer tests, SampleRateQuery tests, CustomVocabulary tests, etc. in recent commits). Updated to ~795 / fewer (CLI tests excluded via #if !APPSTORE) to avoid the number going stale again quickly.

Everything else checked:

  • All source files in app/MeetingTranscriber/Sources/ match docs (including FluidVAD.swift, SampleRateQuery.swift in audiotap already covered by previous commits on this branch)
  • docs/architecture-macos.md is accurate (Sortformer, VAD, mono/stereo channel handling already covered)
  • No new scripts, CI workflows, or entitlement changes since the branch was created

Generated by Claude Code

Copy link
Copy Markdown
Owner Author

pasrom commented Apr 2, 2026

Additional update: README.md was missed in the previous pass. Added four missing user-facing features to the Features section:

  • Parakeet custom vocabulary support (CTC boosting)
  • Sortformer overlap-aware diarizer mode
  • VAD preprocessing (FluidAudio Silero v6)
  • .none protocol provider (save transcript only, no LLM)

Generated by Claude Code

CLAUDE.md:
- Add FluidVAD.swift to project structure
- Add SampleRateQuery.swift + audiotap Tests/ to project structure
- Update FluidDiarizer.swift description (Sortformer mode)
- Update Parakeet description (custom vocabulary via CTC boosting)
- Add VAD preprocessing architecture section
- Add Diarization section (Sortformer / AppSettings.diarizerMode)
- Update build variant test count (~795)

docs/architecture-macos.md:
- Add FluidVAD.swift row to Audio Processing table
- Update AudioTapLib output (mono or stereo, actualChannels)
- Update DualSourceRecorder processing (actual channel count)
- Update FluidDiarizer diarization section (two modes: OfflineDiarizer + Sortformer)

README.md:
- Add Parakeet custom vocabulary support (CTC boosting)
- Add Sortformer overlap-aware diarizer mode
- Add VAD preprocessing feature
- Add .none protocol provider (save transcript only, no LLM)

https://claude.ai/code/session_017weHGLJ3mD4APmtbpLU1jH
@pasrom pasrom force-pushed the docs/auto-update-2026-03-27 branch from 7468bc8 to 8958b70 Compare April 2, 2026 16:35
@pasrom pasrom merged commit 57f6adb into main Apr 2, 2026
6 checks passed
@pasrom pasrom deleted the docs/auto-update-2026-03-27 branch April 2, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants