This directory contains the documentation for Voicebox, built with Mintlify.
Install Mintlify globally using bun:
bun add -g mintlifyOr use the helper script:
bun run install:mintlifybun run devThis will start the Mintlify dev server.
The docs will be available at http://localhost:3000
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
- 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
Docs are automatically deployed when changes are pushed to the main branch.
To manually deploy:
mintlify deploySee CONTRIBUTING.md for contribution guidelines.