mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 12:50:42 -07:00
8929947c7a
The 0.6B slot was aliased to the 1.7B repo as a temporary fallback because `mlx-community/Qwen3-TTS-12Hz-0.6B-Base-bf16` wasn't published when MLX support shipped. That conversion is live now, so use it — Apple Silicon users picking 0.6B get the actual 0.6B model (1.2 GB instead of 3.5 GB). Also drops the now-obsolete troubleshooting entry and updates the triage notes in PROJECT_STATUS.md. Fixes #485. Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]>
title, description
| title | description |
|---|---|
| Documentation README | Voicebox documentation development guide |
This directory contains the documentation for Voicebox, built with Fumadocs.
Development
Running Locally
From the docs/ directory:
bun install
bun run dev
The docs will be available at http://localhost:3000.
Structure
content/docs/overview/— user-facing guides (installation, quick start, feature walkthroughs)content/docs/developer/— architecture, backend internals, and contributor guidescontent/docs/api-reference/— auto-generated from the backend's OpenAPI schemacontent/docs/index.mdx— landing pagepublic/— static assets (images, screenshots, videos)
Writing Docs
- Use
.mdxfiles for all documentation pages - Navigation is generated from
content/docs/meta.jsonfiles - Fumadocs components available:
Callout,Cards/Card,Tabs/Tab,Steps/Step,Accordion/AccordionGroup,Files/Folder/File - API reference pages under
api-reference/are regenerated from the backend's OpenAPI schema — don't edit them by hand
Deployment
Docs are automatically deployed when changes land on main.