mosaic/stack
1
0
Fork 0
Code Issues 10 Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Documentation: Speech services architecture, API, and deployment #406

New Issue
Closed
opened 2026-02-15 07:35:47 +00:00 by jason.woltje · 1 comment
jason.woltje commented 2026-02-15 07:35:47 +00:00
Owner
Copy Link

Description

Comprehensive documentation for the speech services module.

Documents

  1. API Documentation: OpenAPI/Swagger annotations on all endpoints
  2. Architecture Guide: Provider abstraction, tier system, fallback chain
  3. Deployment Guide: Dev setup, production deployment, GPU considerations
  4. AGENTS.md Update: Speech module patterns for AI agents
  5. README Update: Speech capabilities in project README

Key Topics

  • Environment variable reference
  • Provider configuration
  • Voice cloning setup (Chatterbox)
  • GPU VRAM budget considerations
  • WebSocket streaming protocol
  • Frontend integration guide

Acceptance Criteria

  • OpenAPI annotations on all speech endpoints
  • Architecture diagram or description
  • Deployment guide with Docker Compose examples
  • AGENTS.md updated in apps/api/src/speech/
  • README.md updated with speech capabilities
## Description Comprehensive documentation for the speech services module. ## Documents 1. **API Documentation**: OpenAPI/Swagger annotations on all endpoints 2. **Architecture Guide**: Provider abstraction, tier system, fallback chain 3. **Deployment Guide**: Dev setup, production deployment, GPU considerations 4. **AGENTS.md Update**: Speech module patterns for AI agents 5. **README Update**: Speech capabilities in project README ## Key Topics - Environment variable reference - Provider configuration - Voice cloning setup (Chatterbox) - GPU VRAM budget considerations - WebSocket streaming protocol - Frontend integration guide ## Acceptance Criteria - [ ] OpenAPI annotations on all speech endpoints - [ ] Architecture diagram or description - [ ] Deployment guide with Docker Compose examples - [ ] AGENTS.md updated in apps/api/src/speech/ - [ ] README.md updated with speech capabilities
jason.woltje added this to the M13-SpeechServices (0.0.13) milestone 2026-02-15 07:35:47 +00:00
jason.woltje commented 2026-02-15 09:30:16 +00:00
Author
Owner
Copy Link

Completed as part of M13-SpeechServices milestone on branch feature/m13-speech-services. SP-DOCS-001: Speech services documentation (commit 24065aa). All quality gates passed (lint, typecheck, tests, security).

Completed as part of M13-SpeechServices milestone on branch feature/m13-speech-services. SP-DOCS-001: Speech services documentation (commit 24065aa). All quality gates passed (lint, typecheck, tests, security).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
ai
AI/LLM integration
 api
Backend/API work
 api
auth
Authentication
 database
database
Database/schema work
 devops
Docker/deployment
 docs
Documentation
 frontend
graph
knowledge-module
migration
Data migration
 orchestrator
Orchestrator service (apps/orchestrator/)
 p0
Critical priority
 p1
High priority
 p2
Medium priority
 p3
Low priority
 performance
Performance work
 phase-1
phase-2
phase-3
phase-4
phase-5
plugin
MoltBot plugin work
 search
security
Security-related
 setup
Initial setup
 testing
Testing/QA
 web
Frontend work
No Label
Milestone
No items
No Milestone M13-SpeechServices (0.0.13)
Projects
Clear projects
No project
Assignees
Clear assignees
jason.woltje
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: mosaic/stack#406
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?