Files
voicebox/docs
James Pine 3187344f01 add model loading status, effects preset dropdown, clean up UI
Backend:
- Generation service reports 'loading_model' status only when model
  is not yet in memory, then 'generating' once inference starts
- Migrate hf_offline_patch.py from print() to logging module
- Update ADDING_TTS_ENGINES.md for post-refactor file paths

Frontend:
- HistoryTable shows 'Loading model...' vs 'Generating...' based on step
- FloatingGenerateBox: replace instruct toggle + inline effects editor
  with an effects preset dropdown (third dropdown after language and engine)
- Instruct UI removed for now (form field preserved for future models)
- Remove focus ring from Select component globally
2026-03-16 02:58:41 -07:00
..
2026-01-25 21:42:38 -08:00

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 .mdx files for all documentation pages
  • Follow the existing structure in mint.json for 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.