Documentation coverage report¶
Generated: Feb 2025
Summary¶
| Area | Coverage | Notes |
|---|---|---|
| Getting started | ✅ Good | Run locally, Docker, docs |
| Architecture | ✅ Good | Layers, main components |
| Job system | ✅ Good | Flow, job types, XP |
| Events | ✅ Good | Domains, adding events |
| Movement / needs | ✅ Good | Dedicated page |
| Map rendering | ✅ Good | MapView, layers, culling |
| Server | ✅ Good | API, NoiseMapGenerator |
| Sim core | ✅ Good | Objects, interfaces, ObjectManager |
| UI components | ✅ Good | Screens, sidebar, panels |
| Data / gameData | ✅ Good | Registries, orders, zones |
| Refactoring | ✅ Good | GOD_CLASSES_REFACTOR_PROPOSAL |
Documented (new)¶
- Server & map generation – API, flow, NoiseMapGenerator, terrain types
- Sim objects – AbstractObject, ColonistObject, interfaces, ObjectManager, ObjectFactory
- UI structure – screens, layout, Sidebar, Footer, panels
- Movement & needs – tile factors, pathfinding, need decay, event flow
- Map rendering – TerrainLayer, ZoneOverlayLayer, ObjectLayer, culling
- Game data – categoryRegistry, orders, zones, skills, order→action mapping
Also documented¶
- GameSimulation – game-simulation.md – role, current stub, extension notes
- Persistence – persistence.md – SessionManager, GameStatePersistence, save/load flow
- Panel internals – panel-internals.md – InfoPanel, ZonePanel, ObjectPanel, WorkshopPanel, AreaSelectionPanel