From b1efb4ae3ce1a17a4506e758ebeaffb35c66246d Mon Sep 17 00:00:00 2001 From: User Date: Sun, 1 Feb 2026 17:39:15 +0100 Subject: [PATCH] docs: enhance CLAUDE.md with maintenance table - Add table of key docs with "When to Update" guidance - Include TASKS.md, TODO.md, ROADMAP.md, CHANGELOG.md - Add deployment section with node update commands - Add Multi-scanner sync and Termux support to key files Co-Authored-By: Claude Opus 4.5 --- CLAUDE.md | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index de3d8be..29bf196 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,11 +2,23 @@ RF Environment Scanner for WiFi and Bluetooth signal mapping on Linux. -## Key Documentation +## Key Documentation (Maintain These!) + +| File | Purpose | When to Update | +|------|---------|----------------| +| **[TASKS.md](TASKS.md)** | Current sprint tasks, priorities (P0-P3), status | Start/end of each work session | +| **[TODO.md](TODO.md)** | Backlog by category, completed items | When adding/completing features | +| **[ROADMAP.md](ROADMAP.md)** | Version milestones, long-term vision | When milestones change | +| **[CHANGELOG.md](CHANGELOG.md)** | Version history, notable changes | Each release | +| **[PROJECT.md](PROJECT.md)** | Goals, architecture, dependencies | Major architectural changes | +| **[USAGE.md](USAGE.md)** | User guide, CLI, web interface, API | When adding features | +| **[docs/CHEATSHEET.md](docs/CHEATSHEET.md)** | Quick reference commands | When adding features | +| **[INVENTORY.md](INVENTORY.md)** | Multi-node deployment info (gitignored) | When nodes change | + +## Configuration -- **[USAGE.md](USAGE.md)** - User guide with CLI commands, web interface, configuration, and API reference -- **[TODO.md](TODO.md)** - Pending features and improvements - **[config.yaml](config.yaml)** - Current configuration (GPS, web server, scanner, building settings) +- **[docs/HOME_ASSISTANT.md](docs/HOME_ASSISTANT.md)** - Home Assistant webhook integration ## Project Structure @@ -22,6 +34,8 @@ src/rf_mapper/ ├── bluetooth_*.py # Bluetooth device identification and classification ├── visualize.py # ASCII radar and chart generation ├── profiling.py # CPU/memory profiling utilities +├── termux.py # Termux/Android environment detection +├── sync.py # Multi-scanner peer sync └── web/ ├── app.py # Flask application and API endpoints ├── templates/ # Jinja2 HTML templates (base.html, index.html) @@ -38,6 +52,8 @@ src/rf_mapper/ | Change web UI | `web/templates/index.html`, `static/js/app.js`, `static/css/style.css` | | Add configuration | `src/rf_mapper/config.py`, `config.yaml` | | Home Assistant integration | `src/rf_mapper/homeassistant.py`, `docs/HOME_ASSISTANT.md` | +| Multi-scanner sync | `src/rf_mapper/sync.py`, `web/app.py` | +| Termux/Android support | `src/rf_mapper/termux.py` | ## Running @@ -51,9 +67,20 @@ python -m rf_mapper scan -l room # CLI scan python -m rf_mapper --help # All commands ``` +## Deployment + +See [INVENTORY.md](INVENTORY.md) for multi-node deployment details. + +```bash +# Update and restart all nodes +cd ~/git/rf-mapper && source venv/bin/activate && git pull && python -m rf_mapper restart +ssh grokbox "cd ~/git/rf-mapper && source venv/bin/activate && git pull && python -m rf_mapper restart" +ssh jellystar "cd ~/git/rf-mapper && source venv/bin/activate && git pull && python -m rf_mapper restart" +``` + ## Tech Stack -- Python 3.10+, Flask, PyYAML, requests +- Python 3.10+, Flask, PyYAML, requests, bleak - Leaflet.js (2D maps), MapLibre GL JS (3D maps) - Linux tools: `iw`, bleak (BLE via D-Bus) - SQLite for device history