Documentación por componente. Un archivo por componente. Útil para subagentes que tocan UI/Renderer sin necesitar contexto completo.
Crea doc si el componente:
- ✅ Es público / reutilizable (Props son contrato)
- ✅ Tiene lógica no obvia
- ✅ Es candidato a moverse al renderer-r3f (Fase 3)
- ✅ Ha causado bugs o confusión
No documentes componentes triviales (wrappers de 5 líneas).
Pendiente documentar (crear conforme se tocan):
-
GameTouchCanvas— Canvas + Physics + Camera setup -
GameTouchSpriteRuntime— useFrame loop principal -
DavidSprite— Sprite del personaje con animaciones -
SceneBackgroundPlane— Fondo 2.5D -
SceneWalls— Muros con colisión -
SceneGround— Suelo -
SceneCameraControllers— Cámara ortográfica -
SceneCollisionSphere— Esfera de colisión del player -
PlacedSceneItems— Items en la escena
-
InventoryUI— Overlay HTML del inventario -
Joystick— Touch input con nipplejs -
SpeechBubble— Burbuja de diálogo -
DebugOverlayPanel— Panel de debug -
PixelSelect— Selector pixel-art -
WallEditorPanel— Editor de muros (debug) -
GroundEditorPanel— Editor de suelo (debug)
-
AnimatedSprite— Reproductor de atlas
- Copia
_template.mda<ComponentName>.md - Rellena props, eventos, deps, internal structure
- Mantén bajo 50 líneas
Cuando una task toque un componente:
- Lee SOLO
docs/components/<ComponentName>.md -
- el código del componente
- No necesitas leer otros componentes