mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 12:50:42 -07:00
Jamie Pine
2bc243f93e
Solves GitHub 2GB limit + frequent update UX issues by splitting app into: - Main app (~150MB): UI + backend logic + Whisper - TTS Providers (plugins): Separate downloadable binaries - pytorch-cpu (~300MB) - pytorch-cuda (~2.4GB) - mlx (~800MB, macOS) - remote (connect to external server) - openai (API wrapper) Benefits: - Main app under GitHub 2GB limit - Updates don't require re-downloading providers - User choice of compute backend - External provider support for teams/cloud - Future-proof extensibility
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.