Files
voicebox/docs
Richard Orme 19a28bf6c5 a11y: screen reader and keyboard improvements
- Audio player: aria-labels for Play/Pause, Loop, Mute, Close; labelled playback and volume sliders
- Generation: aria-labels for Generate speech and Fine tune instructions buttons
- Voice cards: focusable, labelled, Enter/Space to select
- History rows: focusable, labelled, Enter/Space to play; transcript textarea labelled
- Voices tab: focusable rows, labelled, Enter/Space to edit; Actions button labelled
- Model management: focusable model rows and labelled Download/Delete buttons
- Server tab: regions with aria-label and tabIndex for Connection, Status, App Updates
- Stories: focusable story rows, labelled, Enter/Space to select; Actions and track editor buttons labelled
- Voice profile samples: Play/Pause/Stop and mini-player slider labelled

Tested with NVDA and Narrator on Windows. See docs/PR-ACCESSIBILITY.md for full description.

Made-with: Cursor
2026-03-07 12:02:33 -08:00
..
2026-01-31 02:15:45 -08: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.