docs: tighten privacy claims to reflect first-run model downloads#55
Conversation
- index.md: 'no required network calls' → 'no network calls beyond first-run model downloads' (faster-whisper, MLX, silero-vad all fetch weights from HF on first use) - recipes.md: qualify 'nothing leaves your machine' the same way - compare.md: soften 'Apple analytics (opt-out)' to 'Per Apple's privacy policy' since their exact telemetry isn't publicly documented - FAQ.md + docs/faq.md: clarify default history path is ~/dictate/history.jsonl and configurable via history.path Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Pre-merge checks · ✅ 2 · ⚠ 0 · ❌ 0 · ⏭ 1
|
WalkthroughDocumentation-only change that qualifies privacy claims to acknowledge first-run model downloads from remote sources. Also corrects the default history file path in the FAQ and softens an unverifiable claim about Apple telemetry in the comparison table. Changes
🎯 Effort: 1 (Trivial) · ⏱ ~3 minutes Generated by Sebastion AI · docs |
There was a problem hiding this comment.
Pull request overview
Documentation-only edits to soften privacy claims so they match actual behavior (first-run model downloads from Hugging Face), correct the default history path, and reword the Apple telemetry cell to avoid an unsubstantiated specific claim.
Changes:
- Qualify "no network calls" / "nothing leaves your machine" with a first-run model download caveat in
docs/index.mdanddocs/recipes.md. - Update FAQ (
FAQ.md,docs/faq.md) to show the correct default history path (~/dictate/history.jsonl) and thehistory.pathconfig key. - Soften the Apple telemetry cell in
docs/compare.mdfrom "Apple analytics (opt-out)" to "Per Apple's privacy policy".
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| FAQ.md | Corrects default transcripts path and mentions history.path config key. |
| docs/faq.md | Mirrors the FAQ.md correction. |
| docs/index.md | Adds first-run model download qualifier to the two no-network-calls claims. |
| docs/recipes.md | Adds the same qualifier to the "nothing leaves your machine" line. |
| docs/compare.md | Replaces specific Apple telemetry claim with a neutral reference to Apple's privacy policy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sebastiondev
left a comment
There was a problem hiding this comment.
LGTM — docs honesty pass.
sebastiondev
left a comment
There was a problem hiding this comment.
Still LGTM after empty re-trigger commit.
Small honesty pass on docs claims after a self-review of what the code actually does.
Why
A reader pointed out (correctly) that some privacy claims are slightly stronger than what the code does:
dictate/asr.py:137,dictate/asr_mlx.py,dictate/vad.py:_download_model). So 'no required network calls' and 'nothing leaves your machine' without qualification aren't quite right.<repo>/history.jsonl, but the config key ishistory.pathand the default is~/dictate/history.jsonl— fine when the repo is cloned to~/dictate, misleading otherwise.The Apple SFSpeech backend claim ('no Apple cloud') is correct as-is —
asr_apple.pyforcessetRequiresOnDeviceRecognition_(True)and fails closed if the device can't honour it.Changes
docs/index.md— 'no required network calls' → 'no network calls beyond first-run model downloads'; same qualifier added to the default-pipeline bullet.docs/recipes.md— qualify 'nothing leaves your machine'.docs/compare.md— soften 'Apple analytics (opt-out)' → 'Per Apple's privacy policy'.FAQ.md+docs/faq.md— clarify default history path and that it's configurable viahistory.path.Pure copy edits, no code changes.