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.
53 lines
1016 B
Markdown
53 lines
1016 B
Markdown
---
|
|
name: Bug Report
|
|
about: Report a bug to help improve Vocalinux
|
|
title: "[BUG] "
|
|
labels: bug
|
|
assignees: ''
|
|
---
|
|
|
|
## Bug description
|
|
|
|
A clear description of what went wrong.
|
|
|
|
## Steps to reproduce
|
|
|
|
1.
|
|
2.
|
|
3.
|
|
|
|
## Expected behavior
|
|
|
|
What you expected to happen.
|
|
|
|
## Actual behavior
|
|
|
|
What happened instead.
|
|
|
|
## Screenshots
|
|
|
|
If applicable, attach screenshots.
|
|
|
|
## Environment
|
|
|
|
- **OS / distro**: (e.g. Ubuntu 24.04)
|
|
- **Python version**: (e.g. 3.12; 3.11+ required)
|
|
- **Vocalinux version**: (`vocalinux --version`)
|
|
- **Install method**: (installer / AppImage / AUR / Flatpak / Snap / source / PyPI)
|
|
- **Display server**: (X11 / Wayland)
|
|
- **Desktop environment**: (e.g. GNOME, KDE Plasma)
|
|
- **Speech engine**: (whisper_cpp / whisper / vosk / parakeet / remote_api)
|
|
- **Model**: (e.g. tiny, medium.en-q5_0, v3-european)
|
|
|
|
## Debug logs
|
|
|
|
Run `vocalinux --debug` and paste the relevant output:
|
|
|
|
```
|
|
[paste logs here]
|
|
```
|
|
|
|
## Additional context
|
|
|
|
Anything else that might help (recent upgrade, Bluetooth mic, multi-GPU, etc.).
|