voicebox/docs/content/docs/README.md at 9a8425f401798eb2df4191f8dc45306e68ea9719

Labyricorn/voicebox

Fork 0

mirror of https://github.com/jamiepine/voicebox.git synced 2026-09-16 05:10:42 -07:00

Files

T

ae91aa9a88 docs: audit mdx docs against multi-engine backend (#484 )

* docs: audit mdx docs against multi-engine backend and refresh stale content

Rewrote developer-facing docs that predated the TTSBackend Protocol /
ModelConfig registry refactor (architecture, tts-generation,
model-management, transcription). Updated user-facing docs to reflect all
seven shipped engines (Qwen, Qwen CustomVoice, LuxTTS, Chatterbox,
Chatterbox Turbo, TADA, Kokoro) instead of the outdated "5 engines" claim.

Also fixes:
- Stale app identifier (com.voicebox.app → sh.voicebox.app)
- CUDA backend update flow (now two-archive split, not N-way chunks)
- Whisper model list (removed tiny, added turbo)
- Broken /development/ and /guides/ route links
- Stale just commands and install steps (missing --no-deps chatterbox/tada)
- Removed ASCII art diagrams from README and stories.mdx
- History Generation schema sync with DB model

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

* docs: add DeepWiki badge to README

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

* docs: address PR review feedback

- architecture.mdx: fix backends/ file list (remove nonexistent qwen_backend.py, rename tada_backend.py → hume_backend.py)
- model-management.mdx: Kokoro language count 9 → 8 (matches ModelConfig)
- model-management.mdx: ProgressManager path services/ → utils/
- tts-generation.mdx: ModelConfig example uses field(default_factory=...) — mutable default would raise at runtime
- tts-generation.mdx: "1080p samples" → "on CUDA" (1080p is video, not audio)
- PROJECT_STATUS.md: replace ASCII architecture diagram with prose (matches no-ASCII-art rule)

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

* fix(app): guard against undefined engine in FloatingGenerateBox preset check

form.getValues('engine') returns string | undefined; Set<string>.has()
rejects undefined under strict mode. Added a truthy guard before the
preset lookup.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]>

2026-04-18 21:06:06 -07:00

1.2 KiB

Raw Blame History

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 guides
content/docs/api-reference/ — auto-generated from the backend's OpenAPI schema
content/docs/index.mdx — landing page
public/ — static assets (images, screenshots, videos)

Writing Docs

Use .mdx files for all documentation pages
Navigation is generated from content/docs/meta.json files
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.

1.2 KiB Raw Blame History