Files
voculinux/docs
xavierk 06b7b79664
CI / security (pull_request) Successful in 1m13s
CI / lint (pull_request) Successful in 23s
CI / ai-review (pull_request) Successful in 8s
fix(void): carry python3-pysocks and constrain the audio and SOCKS floors
Void's stock python3-PyAudio (0.2.12_5) and python3-pysocks (1.7.0_8) sit
below the project floors (pyaudio>=0.2.13, PySocks>=1.7.1). voculinux
depended on both by bare name, which an installed stock package already
satisfies, so a user who had the stock packages was never upgraded.

- add packaging/void/srcpkgs/python3-pysocks: PySocks 1.7.1 from the PyPI
  sdist that uv.lock pins (sha256 3f8804571ebe159c380ac6de37643bb4685970655d3bba243530d6558b799aa0)
- voculinux depends on python3-PyAudio>=0.2.14_1 and python3-pysocks>=1.7.1_1
- the install smoke installs the stock packages first, then voculinux, and
  fails unless each reads back as its carried pkgver
- tests: each constraint must name its carried template's current version
  and revision; the stock version must sit below the floor; the depends
  parser refuses malformed tokens instead of stripping them
- docs: "Version floors" in packaging/void/README.md; a pointer in
  docs/RELEASE_PROCESS.md

Refs #16
2026-11-06 21:32:33 +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