Skip to content

docs: bring the remaining docs in line with the three TTS engines - #171

Merged
xilec merged 1 commit into
mainfrom
xilec/docs_three_engines
Aug 1, 2026
Merged

docs: bring the remaining docs in line with the three TTS engines#171
xilec merged 1 commit into
mainfrom
xilec/docs_three_engines

Conversation

@xilec

@xilec xilec commented Aug 1, 2026

Copy link
Copy Markdown
Owner

Summary

Follow-up to #170 — the README was updated to the three-engine lineup, but the same stale "Piper + optional Python Silero" description remained in other docs:

  • docs/index.md — intro and stack table now list all three engines; removed dead links to RewriteNotes.md / RewriteTaskPlan.md / task_history.md (files no longer exist); spec list synced with the actual openspec/specs/ contents
  • AGENTS.md — overview lists Piper (default), silero-native (in-process ONNX Runtime), ttsd (fallback); slim/full build description corrected
  • ai/rules/conventions.md — engine roles updated
  • docs/development.mdtts/ covers all engines, silero-native/ added to the layout tree, slim build no longer described as linking ttsd
  • docs/install.md — Python section is explicitly only for the ttsd engine
  • justfile — slim/full build comments

Docs-only change.

Follow-up to the README update — the rest of the docs still described
the two-engine lineup (Piper + Python Silero):

- docs/index.md: three engines in the intro and stack table; drop dead
  links to removed rewrite-era files; refresh the OpenSpec spec list
- AGENTS.md: three engines in the overview; slim build is Piper +
  native Silero, full only adds ttsd
- ai/rules/conventions.md: engine roles — Piper default, silero-native
  in-process, ttsd opt-in fallback
- docs/development.md: tts/ covers all engines; add silero-native to
  the layout tree; slim build does not link ttsd into PATH
- docs/install.md: the Python section is only needed for ttsd — Piper
  and native Silero work without it
- justfile: slim/full build comments
@xilec
xilec merged commit e4a4a5c into main Aug 1, 2026
6 checks passed
@xilec
xilec deleted the xilec/docs_three_engines branch August 1, 2026 10:42
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