Files
voculinux/docs
xavierk 6c09812271
CI / security (pull_request) Successful in 1m13s
CI / lint (pull_request) Successful in 24s
CI / ai-review (pull_request) Successful in 7s
chore(release): prepare v0.19.0
The first Voculinux release. It has no phase suffix, so the tag is v0.19.0
and the xbps version is 0.19.0_1.

- src/vocalinux/version.py, the Void template (version and _tag), the web
  softwareVersion and package version, the README badge and current-release
  blurb
- docs/UPDATE.md: What's New in v0.19.0, and the source checkout tag
- CHANGELOG.md: v0.19.0 entry from v0.18.5..main, the fork's changes and the
  upstream fixes carried after 0.18.5
- SECURITY.md: 0.19.x is the supported line
- pyproject.toml: project URLs point at git.bongbetic.com/xavierk/voculinux
2026-11-07 01:46:38 +05:30
..
2026-11-07 01:46:38 +05:30

Documentation

User and maintainer documentation for Voculinux.

Document Audience Description
INSTALL.md Users Recommended install, AppImage, AUR, Flatpak, Snap, CLI
INSTALL_MANUAL.md Users Manual install, system packages, PyPI/pipx
TROUBLESHOOTING.md Users Common install and runtime failures
USER_GUIDE.md Users Dictation, engines, models, shortcuts, tips
NIRI.md Users niri keybind pack and Dank Material Shell notes
UPDATE.md Users How to upgrade; release notes by version
DISTRO_COMPATIBILITY.md Users Distro matrix, session caveats
HTTP_REMOTE.md Power users Remote HTTP transcription
FLATPAK_REMOTE.md Users / maintainers Self-hosted Flatpak remote and publishing
GATEWAY_EMBED.md Users Optional local VocaGateway integration
CUSTOM_DICTIONARY_DESIGN.md Contributors Custom terms and correction design
ARCHITECTURE.md Contributors Application modules, data flow, and threads
Performance benchmarks Contributors Before and after charts for the performance pass
AUR.md Arch users / maintainers AUR packages and publish secrets
RELEASE_PROCESS.md Maintainers Version bump, checklist, tagging

Project root:

Document Description
README.md Project overview and quick start
CHANGELOG.md Release history pointers
SUPPORT.md Where to get help
CONTRIBUTING.md Development setup and pull requests
SECURITY.md Vulnerability reporting and supported versions
CODE_OF_CONDUCT.md Community standards

Website product and design notes live under web/ (PRODUCT.md, DESIGN.md, README.md). Flatpak packaging: packaging/flatpak/README.md.

Website: voculinux.com