update-docs
Update Documentation
Guide for updating voxtype documentation across all locations.
Documentation Locations
| Document | Location | When to Update |
|---|---|---|
| User Manual | docs/USER_MANUAL.md |
New features, usage changes |
| Configuration Guide | docs/CONFIGURATION.md |
New config options |
| Troubleshooting | docs/TROUBLESHOOTING.md |
New error conditions, fixes |
| FAQ | docs/FAQ.md |
Common questions |
| README | README.md |
Major features, installation changes |
| Website News | website/news/index.html |
Every release |
| GitHub Release | GitHub Releases | Every release |
| Obsidian Vault | ~/Documents/markdown-notes/Voxtype/ |
Session notes, decisions |
Writing Style
More from peteonrails/voxtype
package-release
Package voxtype for release. Creates deb and rpm packages from binaries. Use when building distribution packages.
22docker-test
Test voxtype in Docker containers. Use for testing builds, verifying packages work on different distros, or isolating test environments.
21regression-test
Run regression tests for voxtype releases. Use before major releases to verify core functionality, CLI commands, and configuration handling.
20build-release
Build all voxtype binaries for release. Builds Whisper (AVX2, AVX-512, Vulkan) and ONNX (AVX2, AVX-512, CUDA) binaries using Docker. Use when preparing a new release.
18aur-publish
Publish voxtype to AUR. Updates PKGBUILD, generates checksums, and pushes to AUR. Use after a GitHub release is published.
18triage
Triage a GitHub issue or PR by checking for duplicates, documentation alignment, project fit, and recommending labels.
17