main
md 32 lines 1.07 KB
Rendered Raw
1 # Kokoro TTS Plugin DOX
2
3 ## Purpose
4
5 - Own built-in Kokoro text-to-speech integration and browser TTS fallback coordination.
6
7 ## Ownership
8
9 - `api/` owns synthesize and status endpoints.
10 - `helpers/` owns runtime and migration behavior.
11 - `hooks.py` owns provider registration/lifecycle behavior.
12 - `webui/` owns settings and speech UI integration.
13 - `default_config.yaml`, `plugin.yaml`, and `README.md` own defaults, metadata, and behavior notes.
14
15 ## Local Contracts
16
17 - Keep Kokoro dependencies on Docker/bootstrap paths, not opportunistic runtime installs.
18 - Preserve browser-native fallback when the plugin is disabled or unavailable.
19 - Do not expose generated speech artifacts outside intended response paths.
20 - Preserve `voice` and `speed` configuration compatibility; weighted blends stay in memory and use positive finite weights.
21
22 ## Work Guidance
23
24 - Coordinate status endpoint behavior with frontend fallback decisions.
25
26 ## Verification
27
28 - Smoke-test status, synthesis, configured voice/speed, and disabled fallback behavior after changes.
29
30 ## Child DOX Index
31
32 No child DOX files.