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.