38 lines
2.3 KiB
Markdown
38 lines
2.3 KiB
Markdown
# Documentation
|
|
|
|
User and maintainer documentation for Voculinux.
|
|
|
|
| Document | Audience | Description |
|
|
|----------|----------|-------------|
|
|
| [INSTALL.md](INSTALL.md) | Users | Recommended install, AppImage, AUR, Flatpak, Snap, CLI |
|
|
| [INSTALL_MANUAL.md](INSTALL_MANUAL.md) | Users | Manual install, system packages, PyPI/pipx |
|
|
| [TROUBLESHOOTING.md](TROUBLESHOOTING.md) | Users | Common install and runtime failures |
|
|
| [USER_GUIDE.md](USER_GUIDE.md) | Users | Dictation, engines, models, shortcuts, tips |
|
|
| [NIRI.md](NIRI.md) | Users | niri keybind pack and Dank Material Shell notes |
|
|
| [cuda-vocu.md](cuda-vocu.md) | Maintainers | Plan: optional CUDA backend in the Void repository |
|
|
| [UPDATE.md](UPDATE.md) | Users | How to upgrade; release notes by version |
|
|
| [DISTRO_COMPATIBILITY.md](DISTRO_COMPATIBILITY.md) | Users | Distro matrix, session caveats |
|
|
| [HTTP_REMOTE.md](HTTP_REMOTE.md) | Power users | Remote HTTP transcription |
|
|
| [FLATPAK_REMOTE.md](FLATPAK_REMOTE.md) | Users / maintainers | Self-hosted Flatpak remote and publishing |
|
|
| [GATEWAY_EMBED.md](GATEWAY_EMBED.md) | Users | Optional local VocaGateway integration |
|
|
| [CUSTOM_DICTIONARY_DESIGN.md](CUSTOM_DICTIONARY_DESIGN.md) | Contributors | Custom terms and correction design |
|
|
| [ARCHITECTURE.md](ARCHITECTURE.md) | Contributors | Application modules, data flow, and threads |
|
|
| [Performance benchmarks](benchmarks/README.md) | Contributors | Before and after charts for the performance pass |
|
|
| [AUR.md](AUR.md) | Arch users / maintainers | AUR packages and publish secrets |
|
|
| [RELEASE_PROCESS.md](RELEASE_PROCESS.md) | Maintainers | Version bump, checklist, tagging |
|
|
|
|
Project root:
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [README.md](../README.md) | Project overview and quick start |
|
|
| [CHANGELOG.md](../CHANGELOG.md) | Release history pointers |
|
|
| [SUPPORT.md](../SUPPORT.md) | Where to get help |
|
|
| [CONTRIBUTING.md](../CONTRIBUTING.md) | Development setup and pull requests |
|
|
| [SECURITY.md](../SECURITY.md) | Vulnerability reporting and supported versions |
|
|
| [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) | Community standards |
|
|
|
|
Website product and design notes live under [`web/`](../web/) (`PRODUCT.md`, `DESIGN.md`, `README.md`). Flatpak packaging: [`packaging/flatpak/README.md`](../packaging/flatpak/README.md).
|
|
|
|
Website: [voculinux.com](https://voculinux.com)
|