sirmrakandQwen-Coder
adac79e765
- Перемещена документация в docs/ с четкой структурой: - tutorials/ — пошаговые руководства (2mic-hat, installer) - integration/ — техническая интеграция (vad-wakeword, mqtt-led) - deployment/ — развёртывание (systemd-services) - architecture/ — архитектура проекта (overview) - Обновлён README.md с навигацией по документации - DEPLOY.md сокращён до quick start с ссылками на docs/ - Добавлен docs/README.md — индекс документации - Создан QWEN.md — контекст для ИИ-ассистента - Удалён мусор: - wyoming_satellite.zip (build artifact) - wyoming-led.service, wyoming-satellite.service (дубликаты) - .qwen/settings.json.orig (бэкап) - .lgd-nfy0 (пустой файл) - docker/run (заглушка) - Обновлён .gitignore: - examples/led_brightness_config.json (автогенерируемый конфиг) - *.old, *.bak, *~ (бэкапы) - *.zip (архивы) - .qwen/settings.json.orig - *.lgd-* (пустые файлы) - led_brightness_config.json исключён из отслеживания (assume-unchanged) Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
# Documentation Index
|
|
|
|
## 📖 For Users
|
|
|
|
| Guide | Description |
|
|
|-------|-------------|
|
|
| [**Deployment**](../../DEPLOY.md) | Quick start and systemd services |
|
|
| [**2-MIC HAT**](tutorials/2mic-hat.md) | Raspberry Pi + ReSpeaker 2-MIC HAT |
|
|
| [**Installer**](tutorials/installer.md) | Interactive installer guide |
|
|
|
|
## 🔧 For Developers
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [**Architecture**](architecture/overview.md) | How Wyoming Satellite works |
|
|
| [**VAD/Wake Integration**](integration/vad-wakeword.md) | Technical integration guide |
|
|
| [**MQTT LED Control**](integration/mqtt-led.md) | LED control with Home Assistant |
|
|
| [**systemd Services**](deployment/systemd-services.md) | Service configuration details |
|
|
|
|
## 📁 Structure
|
|
|
|
```
|
|
docs/
|
|
├── README.md # This file
|
|
├── tutorials/
|
|
│ ├── 2mic-hat.md # 2-MIC HAT setup
|
|
│ └── installer.md # Interactive installer
|
|
├── integration/
|
|
│ ├── vad-wakeword.md # VAD/Wake technical guide
|
|
│ └── mqtt-led.md # LED/MQTT integration
|
|
├── deployment/
|
|
│ └── systemd-services.md # systemd configuration
|
|
└── architecture/
|
|
└── overview.md # High-level architecture
|
|
```
|