feat: Add docs

2026-02-15 16:03:09 -05:00
parent e28c42ddd8
commit 9823bc19d2
14 changed files with 3208 additions and 0 deletions
--- a/STRUCTURE.txt
+++ b/STRUCTURE.txt
@@ -0,0 +1,75 @@
+╔════════════════════════════════════════════════════════════════════════════╗
+║                        ESTRUCTURA DEL PROYECTO                            ║
+║                                                                            ║
+║                         NaliiaBot - Patrón Registry                       ║
+╚════════════════════════════════════════════════════════════════════════════╝
+
+
+📁 RAÍZ DEL PROYECTO
+═══════════════════════════════════════════════════════════════════════════
+
+README.md                      ← Empieza aquí (proyecto)
+README_TOOLS.md                ← Documentación de tools
+pyproject.toml
+htmlcov/
+
+
+📁 docs/ 📚 DOCUMENTACIÓN COMPLETA
+═══════════════════════════════════════════════════════════════════════════
+
+  INICIO.txt                    ← Bienvenida (2 min) ⭐
+
+  TOOLS_DOCUMENTATION_INDEX.md  ← Índice maestro (10 min) ⭐
+  
+  QUICK_START.py                ← Tutorial interactivo (5 min) ⭐
+  
+  TOOLS_GUIDE.md                ← Guía completa (20 min)
+  
+  AGENDA_TOOLS_EXAMPLE.py       ← 5 herramientas reales (15 min)
+  
+  REGISTRY_IMPLEMENTATION_SUMMARY.md
+  
+  README_REGISTRY.md
+  
+  TOOL_REGISTRY_GUIDE.md
+  
+  CHANGES_SUMMARY.md
+
+
+📁 src/naliiabot/bot/tools/ 🔧 CÓDIGO DEL REGISTRY
+═══════════════════════════════════════════════════════════════════════════
+
+  __init__.py                   ← Exporta: ToolRegistry, BaseTool
+  
+  tool_registry.py              ← Infraestructura (BaseTool + Registry)
+  
+  tools.py                      ← ← ← TUS HERRAMIENTAS VAN AQUÍ
+
+
+📁 src/naliiabot/bot/agent/ 🤖 AGENTE
+═══════════════════════════════════════════════════════════════════════════
+
+  agent.py                      ← Agente principal
+  
+  schemas.py                    ← Schemas del agente
+
+
+📁 tests/ ✅ TESTS
+═══════════════════════════════════════════════════════════════════════════
+
+  test_naliia_agent_tools.py    ← Tests de las tools
+  
+  test_agent.py                 ← Tests del agente
+
+
+═══════════════════════════════════════════════════════════════════════════
+
+🚀 COMIENZA AQUÍ:
+
+  1. Lee:   README.md
+  2. Lee:   docs/TOOLS_DOCUMENTATION_INDEX.md
+  3. Lee:   docs/QUICK_START.py
+  4. Crea:  src/naliiabot/bot/tools/tools.py (tus herramientas)
+  5. Testa: pytest tests/test_naliia_agent_tools.py
+
+═══════════════════════════════════════════════════════════════════════════