docs(readme): sync configuration table with .env.template #8

Merged

slaid098 merged 1 commit from docs/readme/sync-config-table into master 2026-08-10 00:32:44 +03:00

Conversation 1 Commits 1 Files changed 1 +8 -2

slaid098 commented 2026-08-10 00:27:44 +03:00

Owner

Copy link

Что сделано

Синхронизирована таблица конфигурации в README.md с актуальным .env.template (source of truth, 83 строки).

Удалено (устаревшие, отсутствуют в .env.template):

• WAKE_ALIASES — алиасы для fuzzy-матчинга
• WAKE_THRESHOLD — порог fuzzy-матчинга

Добавлено (есть в .env.template, пропущены в README):

• WAKE_WORD_DETECTOR — детектор слова активации (openwakeword)
• STT_PROVIDER — провайдер распознавания команд (google / vosk / auto)
• STT_LANGUAGE — язык Google STT (ru-RU)
• MAX_MISUNDERSTAND — максимум непониманий подряд (3)
• PIPER_MODEL — модель Piper TTS (ru_RU-irina-medium.onnx)
• VOSK_STT_MODEL — модель Vosk STT (vosk-model-small-ru-0.22)
• VOSK_TTS_MODEL — модель Vosk TTS (vosk-model-tts-ru-0.7-multi)
• VOSK_TTS_SPEAKER — спикер Vosk TTS 0-4 (2 = Ирина)

Порядок строк сгруппирован по логическим секциям .env.template: слово активации → STT → таймауты → VAD → TTS → модели → погода → YouTube → browser.

Почему

README отстал от .env.template после merge PR #3 (openWakeWord заменил fuzzy-матчинг, добавлены WAKE_WORD_DETECTOR, STT_PROVIDER, STT_LANGUAGE, модели Vosk/Piper) и PR #6 (browser, добавлен BROWSER_PATH). Documentation drift устранён, таблица теперь 1:1 соответствует .env.template.

Watch out

• CHANGELOG.md не тронут — исторические записи остаются как есть
• AGENTS.md уже актуален (содержит все переменные из .env.template)
• Все 21 строк корректны и совпадают с .env.template по дефолтам

Pending

—

Closes #7

Closes #7

## Что сделано Синхронизирована таблица конфигурации в `README.md` с актуальным `.env.template` (source of truth, 83 строки). **Удалено** (устаревшие, отсутствуют в `.env.template`): - `WAKE_ALIASES` — алиасы для fuzzy-матчинга - `WAKE_THRESHOLD` — порог fuzzy-матчинга **Добавлено** (есть в `.env.template`, пропущены в README): - `WAKE_WORD_DETECTOR` — детектор слова активации (`openwakeword`) - `STT_PROVIDER` — провайдер распознавания команд (`google` / `vosk` / `auto`) - `STT_LANGUAGE` — язык Google STT (`ru-RU`) - `MAX_MISUNDERSTAND` — максимум непониманий подряд (`3`) - `PIPER_MODEL` — модель Piper TTS (`ru_RU-irina-medium.onnx`) - `VOSK_STT_MODEL` — модель Vosk STT (`vosk-model-small-ru-0.22`) - `VOSK_TTS_MODEL` — модель Vosk TTS (`vosk-model-tts-ru-0.7-multi`) - `VOSK_TTS_SPEAKER` — спикер Vosk TTS 0-4 (`2` = Ирина) **Порядок строк** сгруппирован по логическим секциям `.env.template`: слово активации → STT → таймауты → VAD → TTS → модели → погода → YouTube → browser. ## Почему README отстал от `.env.template` после merge PR #3 (openWakeWord заменил fuzzy-матчинг, добавлены `WAKE_WORD_DETECTOR`, `STT_PROVIDER`, `STT_LANGUAGE`, модели Vosk/Piper) и PR #6 (browser, добавлен `BROWSER_PATH`). Documentation drift устранён, таблица теперь 1:1 соответствует `.env.template`. ## Watch out - `CHANGELOG.md` не тронут — исторические записи остаются как есть - `AGENTS.md` уже актуален (содержит все переменные из `.env.template`) - Все 21 строк корректны и совпадают с `.env.template` по дефолтам ## Pending — Closes #7 Closes #7

slaid098 added 1 commit 2026-08-10 00:27:44 +03:00

docs(readme): sync configuration table with .env.template 1bce263957

slaid098 commented 2026-08-10 00:32:38 +03:00

Author

Owner

Copy link

Code Review Summary

Code Review Summary

Verdict: APPROVE

Тип изменения: docs-only, правка таблицы конфигурации в README.md.

Что проверено:

1. Source of truth сверка — каждая из 21 строки таблицы в README.md сверена с .env.template (83 строки). Все имена переменных, описания и значения по умолчанию совпадают 1:1.
2. Удаления корректны — WAKE_ALIASES и WAKE_THRESHOLD действительно отсутствуют в .env.template (были удалены в PR #3 при переходе с fuzzy-матчинга на openWakeWord).
3. Добавления полны — все 7 новых переменных (WAKE_WORD_DETECTOR, STT_PROVIDER, STT_LANGUAGE, MAX_MISUNDERSTAND, PIPER_MODEL, VOSK_STT_MODEL, VOSK_TTS_MODEL, VOSK_TTS_SPEAKER) присутствуют в .env.template и корректно перенесены.
4. MAX_MISUNDERSTAND — присутствует в .env.template:34 (default 3), был пропущен в старой таблице, теперь добавлен. Не дублируется.
5. Порядок строк — логическая группировка соответствует секциям .env.template: wake → STT → таймауты → VAD → TTS → модели → погода → YouTube → browser.
6. Сохранённые строки — все 12 существующих корректных строк (WAKE_WORD, WAKE_TIMEOUT_MS, COMMAND_TIMEOUT_MS, SAMPLERATE, CHUNK_MS, VAD_THRESHOLD, SILENCE_LIMIT_MS, TTS_PROVIDER, TTS_CACHE_SIZE, WEATHER_DEFAULT_CITY, OPENWEATHER_API_KEY, YOUTUBE_SEARCH_LIMIT, BROWSER_PATH) сохранены без изменений.
7. Diff минимальный — изменён только блок таблицы (строки 41-57 → 41-63), остальное содержимое README не затронуто.
8. CI green — lint + typecheck + test (matrix 3.12/3.13/3.14) прошли.
9. Локальные проверки — uv run ruff check passed, uv run pytest 217 passed / 1 skipped, coverage 77.76% (≥75%).

Влияние: None — документация не влияет на runtime, тесты не зависят от README.

Риски: None.

Готово к merge.

Verdict: APPROVE

## Code Review Summary ## Code Review Summary ### Verdict: APPROVE **Тип изменения:** docs-only, правка таблицы конфигурации в `README.md`. **Что проверено:** 1. **Source of truth сверка** — каждая из 21 строки таблицы в README.md сверена с `.env.template` (83 строки). Все имена переменных, описания и значения по умолчанию совпадают 1:1. 2. **Удаления корректны** — `WAKE_ALIASES` и `WAKE_THRESHOLD` действительно отсутствуют в `.env.template` (были удалены в PR #3 при переходе с fuzzy-матчинга на openWakeWord). 3. **Добавления полны** — все 7 новых переменных (`WAKE_WORD_DETECTOR`, `STT_PROVIDER`, `STT_LANGUAGE`, `MAX_MISUNDERSTAND`, `PIPER_MODEL`, `VOSK_STT_MODEL`, `VOSK_TTS_MODEL`, `VOSK_TTS_SPEAKER`) присутствуют в `.env.template` и корректно перенесены. 4. **`MAX_MISUNDERSTAND`** — присутствует в `.env.template:34` (default `3`), был пропущен в старой таблице, теперь добавлен. Не дублируется. 5. **Порядок строк** — логическая группировка соответствует секциям `.env.template`: wake → STT → таймауты → VAD → TTS → модели → погода → YouTube → browser. 6. **Сохранённые строки** — все 12 существующих корректных строк (`WAKE_WORD`, `WAKE_TIMEOUT_MS`, `COMMAND_TIMEOUT_MS`, `SAMPLERATE`, `CHUNK_MS`, `VAD_THRESHOLD`, `SILENCE_LIMIT_MS`, `TTS_PROVIDER`, `TTS_CACHE_SIZE`, `WEATHER_DEFAULT_CITY`, `OPENWEATHER_API_KEY`, `YOUTUBE_SEARCH_LIMIT`, `BROWSER_PATH`) сохранены без изменений. 7. **Diff минимальный** — изменён только блок таблицы (строки 41-57 → 41-63), остальное содержимое README не затронуто. 8. **CI green** — lint + typecheck + test (matrix 3.12/3.13/3.14) прошли. 9. **Локальные проверки** — `uv run ruff check` passed, `uv run pytest` 217 passed / 1 skipped, coverage 77.76% (≥75%). **Влияние:** None — документация не влияет на runtime, тесты не зависят от README. **Риски:** None. Готово к merge. ### Verdict: APPROVE

slaid098 merged commit c6877da63d into master 2026-08-10 00:32:44 +03:00

slaid098 deleted branch docs/readme/sync-config-table 2026-08-10 00:32:44 +03:00

slaid098 referenced this pull request from a commit 2026-08-10 00:32:45 +03:00

docs(readme): sync configuration table with .env.template (#8)

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

breaking-change

  

bug

  

ci

  

docs

  

documentation

  

enhancement

  

infrastructure

  

refactor

  

release

No labels

breaking-change

bug

ci

docs

documentation

enhancement

infrastructure

refactor

release

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

slaid098/voice_assistant!8

No description provided.