mirror of https://github.com/jamiepine/voicebox.git synced 2026-09-15 12:50:42 -07:00

Files

T

Jamie Pine 7b5e73cfa8 Add .npmrc for bun usage and update dependencies

- Created a new .npmrc file to enforce bun usage.
- Bumped version numbers for multiple packages to 0.1.9 in bun.lock.
- Added react-sound-visualizer dependency to enhance audio visualization features.
- Introduced convert:assets script in package.json for asset optimization.
- Updated CONTRIBUTING.md with instructions for converting assets to web formats.
- Added documentation files for API endpoints and developer guidelines in the docs directory.

2026-01-29 18:56:10 -08:00

1.4 KiB

Raw Permalink Blame History

Voicebox Documentation

This directory contains the documentation for Voicebox, built with Mintlify.

Development

Prerequisites

Install Mintlify globally using bun:

bun add -g mintlify

Or use the helper script:

bun run install:mintlify

Running Locally

bun run dev

This will start the Mintlify dev server.

The docs will be available at http://localhost:3000

Structure

docs/
├── mint.json           # Mintlify configuration
├── custom.css          # Custom styles
├── overview/           # Getting started & feature docs
├── guides/             # User guides
├── api/                # API reference
├── development/        # Developer documentation
├── logo/               # Logo assets
└── public/             # Static assets

Writing Docs

Use .mdx files for all documentation pages
Follow the existing structure in mint.json for navigation
Use Mintlify components for enhanced formatting (Card, CardGroup, Accordion, etc.)
Reference the Mintlify documentation for available components

Deployment

Docs are automatically deployed when changes are pushed to the main branch.

To manually deploy:

mintlify deploy

Contributing

See CONTRIBUTING.md for contribution guidelines.

1.4 KiB Raw Permalink Blame History