Files
voicebox/docs
James Pine 7c1ea0a1e1 fix: replace netstat with TcpStream + PowerShell for port detection (#277)
On Windows, Voicebox shelled out to netstat.exe on startup to check for
existing server processes. On systems with corrupted DLLs, netstat fails
with 0xc0000142, causing an infinite loading loop.

Replace with:
- TcpStream::connect_timeout() for port-in-use checks (pure Rust)
- PowerShell Get-NetTCPConnection for port-to-PID lookup (built-in cmdlet)
- tasklist for process name verification (unchanged)

Closes #277
2026-03-16 02:15:26 -07:00
..
2026-01-25 21:42:38 -08:00

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.