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:
@@ -1,6 +1,6 @@
|
||||
> ⚠ SUPERSEDED FOR SPECIFICS — the centralized token set is the single source of truth for all numeric values (colors, sizes, spacing).
|
||||
> This document is kept for Rams design philosophy only. Consult the token package (see README.md) for specific value definitions.
|
||||
> Conflicting typography claims in this document (Helvetica/Inter, 5-color palette) are superseded by the token package.
|
||||
> The token package defines 55 color tokens (8 Rams brand colors + Material-style neutrals); palette and typography specifics in this document are superseded.
|
||||
|
||||
DESIGN.md
|
||||
|
||||
@@ -18,13 +18,13 @@ Generous whitespace
|
||||
|
||||
Typography
|
||||
|
||||
Helvetica Neue / Inter
|
||||
Geist (body) / Space Grotesk (headings and telemetry numbers) — per the token package; no Helvetica/Inter anywhere in the design system
|
||||
|
||||
Regular for body, Bold for emphasis
|
||||
|
||||
Sizes: 14px body, 18px headings, 24px titles
|
||||
Sizes come from the --type-* tokens: 14px body (body-md), 20px/32px headings (headline-md/lg), display-lg 48px — exact scale lives in theme/src/tokens.css
|
||||
|
||||
Line height: 1.4× font size
|
||||
Line heights are per-token absolute leading (ratios ~1.08–1.43), defined in theme/src/tokens.css
|
||||
|
||||
Color Palette
|
||||
|
||||
@@ -40,7 +40,7 @@ Matte Black (#1A1A1A)
|
||||
|
||||
Usage:
|
||||
|
||||
Background: Soft Beige
|
||||
Background: --color-background #FFF8F0 (warm white); Soft Beige #D9D2C6 remains a surface/accent token, not the background
|
||||
|
||||
Text: Matte Black
|
||||
|
||||
@@ -70,9 +70,9 @@ Map Snapshots: Grayscale tiles with accent overlays
|
||||
|
||||
Interaction Flows
|
||||
|
||||
Report Event: /report accident → bot confirms → stored in DB → broadcast nearby
|
||||
Report Event (target flow, not built): /report accident → bot confirms → stored in DB → broadcast nearby — no /report command exists yet (implemented commands: /start + /mula, /help, /privacy + /privasi)
|
||||
|
||||
Navigation: /navigate origin → destination → OSRM route → text directions + map snapshot
|
||||
Navigation (target flow, not built): /navigate origin → destination → OSRM route → text directions + map snapshot — no /navigate command and no routing engine wired in yet (routing-adjacent stack today: MapLibre GL + OpenFreeMap tiles); validated future stack is Valhalla + Photon
|
||||
|
||||
Feedback: Minimal confirmation messages
|
||||
|
||||
|
||||
Reference in New Issue
Block a user