Jatin K MalikandGitHub
f48bdda525
* docs: polish project documentation for a clearer public surface Rewrite the README and supporting docs for a more professional first impression: less emoji and badge noise, install-first structure, and a real documentation index. Add a Contributor Covenant, tighten SECURITY and GitHub templates, and make distro/update guides read as product docs instead of internal status notes. * docs: split install guide and add changelog plus support pages Break INSTALL.md into a short primary guide, manual/PyPI package lists, and troubleshooting. Add root CHANGELOG.md and SUPPORT.md, wire them into the docs index and README, and drop the outdated screenshot lag note now that v0.15 assets are on main. * docs: humanize PR copy and remove em dashes Strip em/en dashes from the documentation rewritten in this PR, fix mid-sentence colon fallout from that pass, and smooth a few stiff phrases so the public docs read more natural. * docs: list Faster Whisper after rebase onto main Installer and CLI already accept faster_whisper. Document it next to the other engines, drop the outdated screenshot lag note, and keep the on-device wording honest for local vs remote.
31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
# Documentation
|
|
|
|
User and maintainer documentation for Vocalinux.
|
|
|
|
| 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 |
|
|
| [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 |
|
|
| [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: [vocalinux.com](https://vocalinux.com)
|