mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 04:40:40 -07:00
James Pine
2c1ee94891
Enrich tts-engines.mdx with patterns discovered during TADA integration: - Phase 0.2: new greps for @torch.jit.script, torchaudio.load, gated repos - Phase 3.4: model naming inconsistency warning - Phase 5.2: TADA shim failure added to lessons table - Phase 6: four new workaround sections (gated repos, torchcodec, torch.jit.script, toxic dependency shim pattern) - Checklist: four new items matching the new scan patterns - Remove TADA from upcoming engines (now shipped) Add CUDA_LIBS_ADDON.md exploring --onedir split to avoid 2.4GB redownloads on every version bump.
title, description
| title | description |
|---|---|
| Documentation README | Voicebox documentation development guide |
This directory contains the documentation for Voicebox, built with Fumadocs.
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.