Skip to content

docs: enrich technical, functional, and user guide#27

Merged
pszymkowiak merged 1 commit intomainfrom
docs/enrich-documentation
Mar 6, 2026
Merged

docs: enrich technical, functional, and user guide#27
pszymkowiak merged 1 commit intomainfrom
docs/enrich-documentation

Conversation

@pszymkowiak
Copy link
Copy Markdown
Contributor

Summary

  • Enrich ARCHITECTURE.md with DB schema DDL, SpeakOptions, voice clone resolution, async playback, security strategy, latency table
  • Enrich FEATURES.md with complete MCP tool param reference, preference key table, backend capability matrix, init mode comparison
  • Enrich GUIDE.md with advanced config, MCP verification, clone quality tips, cold/warm troubleshooting, DB recovery

Target: raise doc quality scores from 32/22/46% to 70%+

Test plan

  • Documentation only, no code changes

- ARCHITECTURE.md: add full DB schema DDL, SpeakOptions struct, voice clone resolution
  logic, async PlayHandle pattern, sentence chunking pipeline, security strategy table,
  cold/warm start latency comparison
- FEATURES.md: add complete MCP tool reference (14 tools with all params), preference
  key reference table, backend capability matrix, init mode comparison, vox serve docs
- GUIDE.md: add advanced config (env vars, custom models), MCP verification steps,
  voice clone quality tips, cold/warm start troubleshooting, database recovery,
  backend comparison by use case
@pszymkowiak pszymkowiak merged commit 5626b1b into main Mar 6, 2026
0 of 3 checks passed
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.

1 participant