docs: generate + verify project documentation — canonical docs, per-package READMEs, verified fix pass
- New: docs/ARCHITECTURE.md, docs/GETTING-STARTED.md, docs/DEVELOPMENT.md, docs/TESTING.md, docs/CONFIGURATION.md (colored mermaid diagrams, quoted labels) - Regenerated README.md (arah² / arah2bot naming, canonical clone URL) - New per-package READMEs: theme/, bot/, web/ - Verified 13 docs against the live codebase (2 fix iterations + 2 residual corrections); corrected 56 stale claims across AGENTS/DESIGN/IDEAS/GSD_FIX
This commit is contained in:
@@ -22,7 +22,7 @@ Map snapshots: Delivered as clean images with overlays for traffic events.
|
||||
|
||||
Navigation output: Text-based directions with optional minimalist map tiles.
|
||||
|
||||
Reports: Simple commands (/accident, /traffic, /hazard) with location sharing.
|
||||
Reports: Simple commands with location sharing — planned, not built. Implemented commands today are /start (+ /mula), /help, /privacy (+ /privasi); /accident, /traffic, /hazard are future report commands.
|
||||
|
||||
Feedback loop: Concise updates about nearby events.
|
||||
|
||||
@@ -42,7 +42,7 @@ Matte Black (#1A1A1A)
|
||||
|
||||
Typography:
|
||||
|
||||
Helvetica Neue / Inter
|
||||
Geist (body) / Space Grotesk (headings) — as implemented in the token package; Helvetica Neue / Inter was the original idea
|
||||
|
||||
Regular for body, Bold for emphasis
|
||||
|
||||
@@ -54,23 +54,23 @@ Accident = ⚠️, Traffic = 🚗, Hazard = ⛔
|
||||
|
||||
Architecture Overview
|
||||
|
||||
Frontend: Telegram Bot + optional PWA (Cloudflare Pages)
|
||||
Frontend: Telegram Bot + Mini App on Cloudflare Workers with static assets (Workers superseded Pages; PWA still optional/future)
|
||||
|
||||
Backend Transport: Telegram API
|
||||
Backend: grammY on Cloudflare Workers receiving updates at the POST /telegram/webhook endpoint
|
||||
|
||||
Database: Neon (Postgres + PostGIS)
|
||||
Database today: Cloudflare Workers KV (TTL-only chat sessions); Neon (Postgres + PostGIS) remains the target for event storage
|
||||
|
||||
Routing: OSRM with dynamic traffic weighting
|
||||
Routing: not wired yet — validated target stack is Valhalla + Photon (OSRM references in older docs are superseded)
|
||||
|
||||
Tiles: Maptiler
|
||||
Tiles today: OpenFreeMap (theme/basemap/liberty-rams.json); Maptiler was the original idea
|
||||
|
||||
Queue: RabbitMQ
|
||||
Queue: none yet — RabbitMQ is future/aspirational, deferred out of v1
|
||||
|
||||
Storage: Cloudflare R2
|
||||
Storage: none yet (no R2 binding in bot/wrangler.jsonc); R2 remains a future option for map snapshots
|
||||
|
||||
Monitoring: Prometheus + Grafana
|
||||
Monitoring: none yet — Prometheus + Grafana are future/aspirational
|
||||
|
||||
Email: Resend
|
||||
Email: none yet — Resend is future/aspirational
|
||||
|
||||
Gamification
|
||||
|
||||
|
||||
Reference in New Issue
Block a user