mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 04:40:40 -07:00
James Pine
219cfb1605
- Reflects merged PRs: #254 (LuxTTS/multi-engine), #257 (Chatterbox), #252 (CUDA swap), #238 (download UI) - Updated architecture diagram to show all 4 TTS engines - Added TTS engine comparison table and multi-engine architecture section - Marked resolved bottlenecks (singleton backend, frontend Qwen assumptions) - Updated PR triage: marked #194 and #33 as superseded - Added 'Adding a New Engine' guide (now ~1 day effort) - Updated recommended priorities to reflect current state - Added new API endpoints (CUDA, cancel, active tasks)
Voicebox Documentation
This directory contains the documentation for Voicebox, built with Mintlify.
Development
Prerequisites
Install Mintlify globally using bun:
bun add -g mintlify
Or use the helper script:
bun run install:mintlify
Running Locally
bun run dev
This will start the Mintlify dev server.
The docs will be available at http://localhost:3000
Structure
docs/
├── mint.json # Mintlify configuration
├── custom.css # Custom styles
├── overview/ # Getting started & feature docs
├── guides/ # User guides
├── api/ # API reference
├── development/ # Developer documentation
├── logo/ # Logo assets
└── public/ # Static assets
Writing Docs
- Use
.mdxfiles for all documentation pages - Follow the existing structure in
mint.jsonfor navigation - Use Mintlify components for enhanced formatting (Card, CardGroup, Accordion, etc.)
- Reference the Mintlify documentation for available components
Deployment
Docs are automatically deployed when changes are pushed to the main branch.
To manually deploy:
mintlify deploy
Contributing
See CONTRIBUTING.md for contribution guidelines.