docs: documentation improvements and CLAUDE.md#160
Merged
basnijholt merged 8 commits intomainfrom Jan 3, 2026
Merged
Conversation
…stall-hotkeys formatting - Update docs-review.md to reflect that options tables are now auto-generated via the docs_gen module, removing manual verification steps - Add docs_gen function reference and update_docs.py command - Shift review focus to prose, examples, and workflows that still need judgment - Fix install-hotkeys.md markdown list formatting with proper blank lines and bold platform headers
- Fix `uv tools install` → `uv tool install` typo across installation docs - Convert emoji callout to GitHub-style `> [!WARNING]` in docker.md - Update "Wyoming Faster Whisper" → "Wyoming Whisper" with platform notes (faster-whisper on Linux/Intel, MLX Whisper on Apple Silicon) - Fix `gpt-5-mini` → `<your-model>` placeholder in rag-proxy examples - Remove `wsl` prefix from Windows AutoHotkey scripts - Improve macOS service documentation with brew/launchd options - Clarify transcribe behavior (Wyoming streams live vs OpenAI uploads) - Minor wording improvements in index.md
Add development guidance file including: - Development rules (functional style, DRY, simplicity, testing) - Build and development commands (uv, pytest, pre-commit, ruff) - Architecture overview (CLI structure, provider pattern, key modules) - Agent pattern documentation - Background process management - Documentation auto-generation workflow
basnijholt
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.mdwith development guidance for Claude Code.prompts/docs-review.mdto reflect auto-generated options tables (from feat(docs): add docs_gen module for auto-generating option tables #159)Changes
New file:
CLAUDE.md- Development rules, build commands, and architecture overviewDocumentation review prompt:
docs_genmoduleFixes across docs:
uv tools install→uv tool installtypo fixes> [!WARNING]in docker.mdgpt-5-mini→<your-model>placeholder in rag-proxy exampleswslprefix from Windows AutoHotkey scriptsTest plan