voicebox

Labyricorn/voicebox

Fork 0

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

Files

T

History

James PineandClaude Opus 4.7 a179b826cd docs: consolidate troubleshooting into the MDX docs site + status updates

- Delete docs/TROUBLESHOOTING.md; the canonical troubleshooting guide now
  lives under docs/content/docs/overview/troubleshooting.mdx so it's served
  from docs.voicebox.sh alongside the rest of the docs.
- CONTRIBUTING.md + README.md: repoint "Troubleshooting" references to the
  new MDX path. README gets a top-level callout so users hit the guide
  before filing an issue.
- PROJECT_STATUS.md: refresh issue/PR counts, document the flash-attn
  warning (cosmetic on all platforms; CUDA-only, fallback is PyTorch SDPA
  which is near-FA2 on Ampere+) with per-platform context + community
  Windows wheels + SageAttention/xformers alternatives, add WebAudio
  audio-session bug note (tracked separately in PR #486), and expand the
  Qwen 0.6B→1.7B MLX fallback explanation for triage.

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

2026-04-18 23:20:35 -07:00

api-reference

add release skills, backfill changelog, wire CI to use changelog for GitHub releases

2026-03-16 06:18:46 -07:00

developer

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

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

overview

docs: consolidate troubleshooting into the MDX docs site + status updates

2026-04-18 23:20:35 -07:00

index.mdx

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

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

meta.json

expand sidebar groups by default, remove stale plans reference

2026-03-16 04:08:46 -07:00

README.md

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

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

README.md

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.