voicebox/docs2/content/docs/README.md at external-provider-binaries

mirror of https://github.com/jamiepine/voicebox.git synced 2026-09-15 04:40:40 -07:00

Files

T

Jamie Pine f090759d8f Add Docker support and update dependencies

- Introduced Docker support with CPU-only and GPU-enabled configurations via Dockerfiles and docker-compose files.
- Added a .dockerignore file to exclude unnecessary files from Docker images.
- Updated bun.lock and package.json to include new dependencies for icon handling.
- Enhanced README with Docker usage instructions and deployment options.
- Refactored components to utilize new icon libraries for improved UI consistency.

2026-02-02 02:19:05 -08:00

1.4 KiB

Raw Permalink Blame History

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 .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.

1.4 KiB Raw Permalink Blame History