diff --git a/README.md b/README.md index 18f61f0..3c065bf 100644 --- a/README.md +++ b/README.md @@ -71,11 +71,17 @@ As you save settings, MeshAI persists them back into `/data` as focused per-doma ```bash git clone https://github.com/zvx-echo6/meshai.git cd meshai/work +cd dashboard-frontend && npm ci && npm run build && cd .. # builds the web dashboard — required, see note pip install -e . cp config.example.yaml config.yaml # minimal starting point, not exhaustive — see note below meshai ``` +> **The frontend build step is required.** `meshai/dashboard/static/` is no longer +> committed to the repo, so skipping it means no dashboard UI is served (the bot and +> API still run fine). Docker users don't need this — the image builds the frontend +> automatically. Requires Node.js/npm. + Unlike Docker, `meshai` won't create a config file for you — it needs one to exist before it will start. `config.example.yaml` bootstraps the basics (connection, LLM backend, bot behavior); once it's running, open `http://localhost:8080` and use the dashboard for everything else. > **Note on `config.example.yaml`:** it documents the legacy single-file schema and is no longer complete — it predates `coverage`, `danger_zones`, `generic_sources`, `meshcore_context`, `commands`, and the current 8-family notification-routing model (`notifications.toggles` / `destinations` / `region_routes`). The legacy single-file loader still works and is fully supported, but the dashboard — backed by the full config schema — is the authoritative way to reach every setting. Don't treat this file as a complete reference. diff --git a/work/README.md b/work/README.md index 26f5a62..5c40839 100644 --- a/work/README.md +++ b/work/README.md @@ -55,17 +55,11 @@ Everything is driven from the web UI, organized into **General**, **Meshtastic** ```bash git clone https://github.com/zvx-echo6/meshai.git cd meshai -cd dashboard-frontend && npm ci && npm run build && cd .. # builds the web dashboard -- required, see note below pip install -e . cp config.example.yaml config.yaml # then edit config.yaml (or use the dashboard) meshai ``` -> The frontend build step is required. `meshai/dashboard/static/` is no longer -> committed to the repo, so skipping it means no dashboard UI is served (the -> bot and API still run fine). Docker users don't need this -- the image -> builds the frontend automatically. Requires Node.js/npm. - Or with Docker: ```bash