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.
1.7 KiB
1.7 KiB
Support
Where to get help with Vocalinux.
Documentation
| Topic | Doc |
|---|---|
| Install | docs/INSTALL.md |
| Manual / PyPI install | docs/INSTALL_MANUAL.md |
| Troubleshooting | docs/TROUBLESHOOTING.md |
| Day-to-day use | docs/USER_GUIDE.md |
| Upgrading | docs/UPDATE.md |
| Distros and sessions | docs/DISTRO_COMPATIBILITY.md |
| Remote transcription API | docs/HTTP_REMOTE.md |
| Full index | docs/README.md |
| Website | vocalinux.com |
Community
| Channel | Use for |
|---|---|
| Discord | Fastest place to talk with maintainers |
| GitHub Discussions | Questions, setup help, ideas |
| Bug report | Something is broken |
| Feature request | New capability proposals |
When filing a bug, include OS/distro, vocalinux --version, install method, display server (X11/Wayland), engine, and a vocalinux --debug snippet.
Security
Do not post vulnerability details in public issues. Follow SECURITY.md.
Contributing
Code and docs: CONTRIBUTING.md. Community standards: CODE_OF_CONDUCT.md.
Maintainer contact
General product questions are best on Discussions or Discord so others can find the answer. Security only: see SECURITY.md.