docs: update references to deleted files

- QUICKSTART.md: replace data_description.md.example copy step with
  note that tables are registered via the admin API or web UI
- NOTIFICATIONS.md: replace examples/ section with planned-feature note
- telegram_bot.md: remove examples/notifications/ rows from deployment
  table and example scripts section; note feature is planned
- dev_docs/README.md: remove plan-corporate-memory.md entry
- duckdb_manager.py: update comment from remote_query.py to query API endpoint
This commit is contained in:
ZdenekSrotyr 2026-04-09 17:15:19 +02:00
parent f3bd378b47
commit 22cfbfe5fb
5 changed files with 5 additions and 26 deletions

View file

@ -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

View file

@ -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

View file

@ -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:

View file

@ -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

View file

@ -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)