From 462a5a93830d0c88964f4b6017ebb4f660c327e5 Mon Sep 17 00:00:00 2001 From: Luca Sacchi Ricciardi Date: Fri, 3 Apr 2026 16:34:09 +0200 Subject: [PATCH] docs: update README with real project status Reflect actual project progress in README: - Sprint 2: COMPLETED (AI Pipeline + Telegram alerting) - Sprint 3: IN PROGRESS (~80% - Landing Page development) - Updated MVP features status with file references - Changed sprint badge from 1 to 2 completed Previous README showed Sprint 2/3 as 'in planning' when they were actually completed/in progress. Now accurately reflects: - Log Ingestion: DONE (scripts/) - AI Processing: DONE (workflows/ with OpenRouter) - Telegram Alerting: DONE (docs/telegram_setup.md) - Landing Page: IN PROGRESS (frontend/ 80% complete) --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 600e54e..b80be4d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Tests](https://img.shields.io/badge/tests-12%2F12%20passing-brightgreen)]() [![Version](https://img.shields.io/badge/version-0.1.0-blue)]() -[![Sprint](https://img.shields.io/badge/sprint-1%20completed-success)]() +[![Sprint](https://img.shields.io/badge/sprint-2%20completed-success)]() [![Status](https://img.shields.io/badge/status-active%20development-orange)]() @@ -17,17 +17,19 @@ LogWhisperer AI trasforma i log di sistema e database spesso incomprensibili in | Feature | Stato | Sprint | |---------|-------|--------| | ✅ Log Ingestion Script | **Completato** | Sprint 1 | -| 🔄 AI Processing Pipeline | *In pianificazione* | Sprint 2 | -| 🔄 Alerting (Telegram/Slack) | *In pianificazione* | Sprint 2-3 | -| 🔄 Landing Page & Onboarding | *In pianificazione* | Sprint 3 | +| ✅ AI Processing Pipeline | **Completato** | Sprint 2 | +| ✅ Alerting (Telegram) | **Completato** | Sprint 2 | +| 🚧 Landing Page & Onboarding | *In corso (~80%)* | Sprint 3 | ### Funzionalità MVP -- **Log Ingestion** ✅: Script Bash leggero per il monitoraggio (tail -f) di log critici (syslog, nginx, postgres). Invia payload JSON via HTTP POST a webhook. +- **Log Ingestion** ✅: Script Bash leggero per il monitoraggio (tail -f) di log critici (syslog, nginx, postgres). Invia payload JSON via HTTP POST a webhook. Script disponibili in `scripts/`. -- **AI Processing Pipeline** 🔄: Workflow su n8n che analizza i log tramite LLM (OpenAI/Anthropic) applicando il Metodo Sacchi (Safety first, little often, double check). +- **AI Processing Pipeline** ✅: Workflow n8n completo che riceve log via webhook, valida HMAC, analizza con OpenRouter (GPT-4o-mini) e restituisce JSON con analisi e comando risolutivo. Workflow in `workflows/logwhisperer_ingest.json`. -- **Alerting Umano** 🔄: Notifiche su Telegram/Slack con sintesi del problema, severità e comando esatto per la mitigazione. +- **Alerting Umano** ✅: Notifiche su Telegram con sintesi del problema, severità e comando esatto. Configurazione in `docs/telegram_setup.md`. + +- **Landing Page** 🚧: Interfaccia web React + Vite + Tailwind CSS con Hero, Problem/Solution, How It Works, e Demo Interattiva. In sviluppo in `frontend/`. 🛠️ Stack Tecnologico Core Logic: Python 3.12+ (in venv)