diff --git a/dev_docs/README.md b/dev_docs/README.md index 7aa2afc..6ccd32d 100644 --- a/dev_docs/README.md +++ b/dev_docs/README.md @@ -19,7 +19,6 @@ This folder contains documentation for **developers and server administrators** - `insights.md` - Activity Center dashboard feature documentation ### Planning & Meetings -- `plan-corporate-memory.md` - Corporate Memory module implementation plan - `meetings/` - Meeting transcripts, summaries, and notes ## For Analysts diff --git a/dev_docs/telegram_bot.md b/dev_docs/telegram_bot.md index 2b9430f..e2abe0a 100644 --- a/dev_docs/telegram_bot.md +++ b/dev_docs/telegram_bot.md @@ -98,15 +98,7 @@ Installed to `/usr/local/bin/notify-runner`. Users set up their own crontab. ### 4. Example Scripts -**Source:** `examples/notifications/` - -| Script | Description | -|--------|-------------| -| `revenue_drop.py` | Text-only alert when revenue drops vs 7-day average | -| `metric_report.py` | Daily report with matplotlib chart (image notification) | -| `data_freshness.py` | Alert when local parquet data is stale | - -Deployed to `/data/docs/examples/notifications/` on the server. +Note: notification example scripts have been removed. This feature is planned for a future release. ## Data Storage @@ -171,7 +163,6 @@ Scripts output JSON to stdout: | `server/bin/notify-scripts` | `/usr/local/bin/notify-scripts` | | `server/bin/notify-runner` | `/usr/local/bin/notify-runner` | | `services/telegram_bot/systemd/notify-bot.service` | `/etc/systemd/system/notify-bot.service` | -| `examples/notifications/*.py` | `/data/docs/examples/notifications/` | | `docs/notifications.md` | `/data/docs/notifications.md` | ### Changes to existing deploy scripts diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.md index c19888a..816dbbb 100644 --- a/docs/QUICKSTART.md +++ b/docs/QUICKSTART.md @@ -30,10 +30,9 @@ # Edit .env with your data source credentials ``` -5. Create your data description: +5. Register your tables: ```bash - cp config/data_description.md.example docs/data_description.md - # Edit docs/data_description.md to define your tables + # Tables are registered via the admin API or web UI — no config file needed ``` 6. Sync data: diff --git a/docs/future/NOTIFICATIONS.md b/docs/future/NOTIFICATIONS.md index 82340de..0d5ce6b 100644 --- a/docs/future/NOTIFICATIONS.md +++ b/docs/future/NOTIFICATIONS.md @@ -179,17 +179,7 @@ cat ~/.notifications/state/my_alert.json ## Examples -Example scripts are available in `~/server/examples/notifications/`: - -- `revenue_drop.py` - text-only alert when revenue drops significantly -- `metric_report.py` - daily report with matplotlib chart -- `data_freshness.py` - alert when local data is stale - -Copy an example to get started: - -```bash -cp ~/server/examples/notifications/data_freshness.py ~/user/notifications/ -``` +# Notification examples are documented here. Implementation is planned for a future release. ## Troubleshooting diff --git a/scripts/duckdb_manager.py b/scripts/duckdb_manager.py index 6f261cc..5f99954 100644 --- a/scripts/duckdb_manager.py +++ b/scripts/duckdb_manager.py @@ -289,7 +289,7 @@ def create_local_views( """Create DuckDB views for local/hybrid tables from Parquet files. Extracts the shared logic from init_duckdb() so it can be reused - by remote_query.py without creating a persistent DB file. + by the query API endpoint without creating a persistent DB file. Args: conn: Open DuckDB connection (in-memory or file-backed)