Skip to content

Latest commit

 

History

History

README.md

tinyRacing documentation

Knowledge base for humans and AI agents. Derived from the codebase; prefer these files over older root-level API notes.

Last verified: 2026-05-20

Index

File Contents
01-product-overview.md What the game is, feature areas, core loops
02-user-requirements.md Screens, routes, user stories, navigation
03-functional-requirements.md Business rules and validation
04-architecture.md System components and data flow (text)
05-backend.md Rust server modules
06-frontend.md Vue app structure
07-api-reference.md REST API (actual implementation)
08-websocket.md Live race WebSocket
09-database.md PostgreSQL schema
10-simulation-model.md In-memory race simulation
11-known-gaps.md Known limitations and outdated docs

Entry point for agents: ../AGENTS.md

Retired documentation: archive/README.md