Files

T

soubarnak de548d6a56 docs(release): write upstream cherry-pick policy into release process

Intake at release-preparation sync points plus on-demand critical
fixes, freeze once the release branch opens to release-blockers only,
one upstream fix per fork pull request through the standard gates,
conflicts resolved by keeping upstream logic and re-applying fork
renames, and the qualification rule (fixes and user-instruction docs
port; features re-decided; dependency/CI churn only on a security
advisory). Names the retained internal vocalinux module as the reason
conflicts concentrate at renamed user-visible surfaces.

Tests: tests/test_upstream_intake_policy.py (7 tests)

2026-11-05 22:46:41 +05:30

benchmarks

perf: faster Settings, typing and dictation; mypy in CI, engine interface, architecture docs (#968 )

2026-10-20 20:23:08 -07:00

images

feat(overlay): live mic orb with audio-reactive pulse and ripple (#940 )

2026-10-11 23:07:07 -07:00

ARCHITECTURE.md

perf: faster Settings, typing and dictation; mypy in CI, engine interface, architecture docs (#968 )

2026-10-20 20:23:08 -07:00

AUR.md

fix(aur): gate source publication on attested sdists (#1020 )

2026-10-26 20:26:04 -07:00

CUSTOM_DICTIONARY_DESIGN.md

feat(dictionary): combined custom dictionary with corrections (#890 )

2026-09-30 02:33:49 -07:00

DISTRO_COMPATIBILITY.md

refactor(installer): generate distro package map (#872 )

2026-09-29 21:16:03 -07:00

FLATPAK_REMOTE.md

fix(ci): warn loudly when the Flatpak remote publish skips (#961 )

2026-10-16 09:20:44 -07:00

GATEWAY_EMBED.md

feat(settings): run local VocaGateway from Advanced (podman-first) (#774 )

2026-09-29 15:33:27 -07:00

HTTP_REMOTE.md

feat(settings): run local VocaGateway from Advanced (podman-first) (#774 )

2026-09-29 15:33:27 -07:00

INSTALL_MANUAL.md

refactor(installer): generate distro package map (#872 )

2026-09-29 21:16:03 -07:00

INSTALL.md

fix(snap): build from locked python inputs and verify artifacts (#1041 )

2026-11-02 12:31:14 -08:00

MODEL_SELECTION.md

fix(settings): make model downloads explicit and cancel the whole intent (#1006 )

2026-10-21 01:04:10 -07:00

README.md

perf: faster Settings, typing and dictation; mypy in CI, engine interface, architecture docs (#968 )

2026-10-20 20:23:08 -07:00

RELEASE_PROCESS.md

docs(release): write upstream cherry-pick policy into release process

2026-11-05 22:46:41 +05:30

SNAP.md

fix(snap): build from locked python inputs and verify artifacts (#1041 )

2026-11-02 12:31:14 -08:00

TROUBLESHOOTING.md

fix(audio): prevent dictation hangs on stalled microphones (#974 )

2026-10-26 21:25:50 -07:00

UPDATE.md

fix(ui): escape device names and test errors in the audio status label (#1043 )

2026-11-02 18:46:31 -08:00

USER_GUIDE.md

fix(audio): prevent dictation hangs on stalled microphones (#974 )

2026-10-26 21:25:50 -07:00

README.md

Documentation

User and maintainer documentation for Vocalinux.

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
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: vocalinux.com