mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 04:40:40 -07:00
Jamie Pine
94487f32a5
- Added support for MLX backend on Apple Silicon, enabling optimized performance for TTS and STT tasks. - Implemented platform detection to dynamically select between MLX and PyTorch based on the runtime environment. - Updated build process to include MLX-specific dependencies and configurations for macOS. - Refactored backend code to improve model loading and inference logic, accommodating backend-specific requirements. - Enhanced documentation to clarify backend selection and performance benefits for different platforms. - Streamlined installation instructions and troubleshooting guidance for MLX-related issues.
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.