mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-17 05:40:42 -07:00
Problem: The server binary with CUDA support was 2.9GB, causing: - MSI installer failures in CI (WiX can't handle 3GB files) - Massive downloads for all users (even those without GPUs) - Poor user experience Solution: Build two separate server binaries: - voicebox-server.exe (CPU-only, ~295MB) - ships with installer - voicebox-server-cuda.exe (CUDA, ~2.9GB) - optional download Changes: - backend/build_binary.py: Added 'variant' parameter for CPU/CUDA builds - backend/build_cpu.bat: Script to build CPU-only binary - backend/build_cuda.bat: Script to build CUDA binary - backend/build_both.bat: Script to build both binaries - backend/build_cpu.sh: Unix build script for CPU binary - .github/workflows/release.yml: Build both variants, upload CUDA separately - tauri/vite.config.ts: Externalize Tauri plugins to fix build - docs/dual-server-binaries.md: Complete documentation Results: - Installer size reduced from 3GB to ~500MB (6x smaller) - CI builds now succeed (WiX can handle 500MB) - GPU users can opt-in to download CUDA support - Better bandwidth usage for CPU-only users Next steps: - Frontend implementation to detect GPU and download CUDA binary - Settings UI to toggle between CPU/CUDA modes Co-Authored-By: Claude Sonnet 4.5 (1M context) <[email protected]>
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.