docs(voice): write the authentic-voice cluster (Cycle 20)#24
Merged
Conversation
…ourcing (Cycle 20) Fill the three docs/voice/* stubs so the "want the real voice?" CTA chain (README + docs landing + developer pages + glossary) stops dead-ending in a placeholder. Audience spans curious users and developers; plain and friendly, spec voice/tone. Canonical-home split (no duplication, no contradiction): - Per-platform step-by-step stays canonical in docs/install/*.md (Tier 2); voice/setup.md explains the setup CONCEPTUALLY (architecture, the 3 files, the one-command flow, cache + first-utterance notes) and LINKS to the install guides for the actual OS steps — it does not re-paste them. - The detailed sourcing list + IP posture stays canonical in legal-and-assets.md; voice/sourcing-components.md is the friendly front door that summarizes and links into it. No direct proprietary download links in voice/* (ADR-0006/0027 posture upheld). - voice/overview.md is the new conceptual hub: the two voices + tradeoff, what L&H TruVoice/SAPI4 is, and why it needs a backend (ADR-0004). README: drop now-stale "(coming soon)" on the voice CTA and "is coming in" → "is in" for the sourcing companion (both pages are real now). No path churn. All facts verified against the repo (ports 8090/8080, POST /tts, the 3 vendor paths, docker compose up vs up mash, pre-filled :8080). Docs only; CI green; verified by code-reviewer (no install-step dup, no legal contradiction, no proprietary links, links resolve). 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.
Fills the three
docs/voice/*stubs so the entire "want the real voice?" CTA chain (README + docs landing + developer pages + glossary) stops dead-ending in a placeholder. Audience spans curious users and developers; plain, friendly, spec voice/tone.Cycle spec:
docs/cycles/cycle-20-voice-docs.md.Pages
voice/overview.md(the hub) — the two voices and the tradeoff (browser fallback = instant, not original; authentic = the real TruVoice + exact lip-sync, needs a helper), what L&H TruVoice / SAPI 4 actually is, and why it needs a backend (closed 1990s Win32 software can't run in-browser — ADR-0004).voice/setup.md— the conceptual setup hub: how the pieces fit (MASH:8090↔ voice helper:8080, the call happens in the browser, pre-filled URL, clear-to-silence), the 3 files + where they live, the one-commanddocker compose upflow (Docker-only, ADR-0027), the cache (repeats instant) and honest first-utterance clip note — then hands off to the install guides for the OS steps.voice/sourcing-components.md— the friendly front door for the three supplied files; defers tolegal-and-assets.mdfor the authoritative source list.The no-duplication / no-contradiction decision (explicit)
docs/install/*(Tier 2)setup.mdlinks, never re-pastesdocs/legal-and-assets.mdsourcing-components.mdsummarizes + linksvoice/overview.md+setup.mdNo install steps duplicated. No contradiction with legal-and-assets.md. No direct proprietary download links anywhere in
voice/*(those stay only in legal-and-assets.md). README CTAs updated for accuracy (the pages are real now): dropped "(coming soon)" on the voice CTA, "is coming in" → "is in" for the sourcing companion — no path churn.Verification
pnpm -r typecheck && pnpm -r test && pnpm lint && pnpm format— green (docs only).POST /tts, the 3 vendor paths,docker compose upvsup mash, pre-filled:8080); every relative link resolves; the three pages cross-link each other + the docs landing + install pages.code-reviewerverified all six obligations clean — no install-step duplication, no legal-and-assets contradiction, no proprietary links, facts/ADRs correct, links resolve, scope docs-only.Out of scope: the help cluster (getting-started, faq, troubleshooting) — next cycle. Base
main, not merged.🤖 Generated with Claude Code