mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 21:00:42 -07:00
Jamie Pine
827ce2bf0a
CONTRIBUTING.md caught up with reality: ruff not Black, Python 3.12, sh.voicebox.app, the routes/services/backends layout, the actual pytest + CI story, and a working autoupdater link. SECURITY.md now says 0.5.x and describes what CI actually enforces. The root requirements.txt was vestigial (unpinned, included torchvision, referenced by nothing) — deleted, with two stale doc references repointed at backend/requirements.txt. backend/pyproject.toml is now covered by bumpversion; its version was stuck at 0.2.3 and is synced to 0.5.0.
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.