Add documentation for modules and runtime instructions

- Created detailed documentation for the device_manager, model, model_extra, osc, overlay, overlay_image, transcription, translation, transliteration, utils, watchdog, and websocket modules.
- Added a comprehensive run events payloads document outlining the payloads sent during various run events in the controller.
- Included runtime instructions and dependencies for setting up the project in a Windows environment.
- Introduced a mypy configuration file to manage type checking and ignore errors in specific modules temporarily.
This commit is contained in:
misyaguziya
2025-10-09 13:11:59 +09:00
parent b0fd63afbd
commit 5efa9c37d6
23 changed files with 2147 additions and 0 deletions

18
src-python/docs/README.md Normal file
View File

@@ -0,0 +1,18 @@
# VRCT — ドキュメント
このドキュメントセットは、VRCT プロジェクト(`src-python`)に含まれる実装の仕様書 / 設計書 / 詳細設計書です。
目的
- ソースコード構造、モジュール間データフロー、API エンドポイント、設定、実行手順、トラブルシュートを網羅して開発・運用の参照を容易にする。
対象
- `utils.py`, `model.py`, `controller.py`, `mainloop.py`, `device_manager.py`, `config.py` および `models/` 以下の全モジュール。
ドキュメント構成(主要ファイル)
- `architecture.md` — アーキテクチャ概観
- `modules/` — 各モジュールごとの詳細設計(個別ファイル)
- `api.md` — 外部/内部向け API エンドポイント マッピング(`mainloop.py``mapping` / `run_mapping` に準拠)
- `runtime.md` — 実行/セットアップ手順、依存関係
- `diagrams.md` — システム図Mermaid とテキスト両方)
- `CODING_RULES.md` — プロジェクト固有のコーディング規約命名・型方針・lint/mypy 方針 等)
- `CHANGELOG.md` — 変更履歴