67 lines
2.4 KiB
Markdown
67 lines
2.4 KiB
Markdown
# 📚 Índice Rápido
|
|
|
|
## 🚀 Punto de partida
|
|
|
|
| Necesito | Archivo |
|
|
|----------|---------|
|
|
| Entender el proyecto | [README.md](README.md) |
|
|
| Entender las tools | [README_TOOLS.md](README_TOOLS.md) |
|
|
| Ver la estructura | [STRUCTURE.txt](STRUCTURE.txt) |
|
|
|
|
## 📖 Documentación (en `docs/`)
|
|
|
|
| Archivo | Tiempo | Descripción |
|
|
|---------|--------|-------------|
|
|
| **[docs/INICIO.txt](docs/INICIO.txt)** | 2 min | Bienvenida y guía visual |
|
|
| **[docs/TOOLS_DOCUMENTATION_INDEX.md](docs/TOOLS_DOCUMENTATION_INDEX.md)** | 10 min | Índice maestro de toda la documentación |
|
|
| **[docs/QUICK_START.py](docs/QUICK_START.py)** | 5 min | Tutorial interactivo para empezar |
|
|
| [docs/TOOLS_GUIDE.md](docs/TOOLS_GUIDE.md) | 20 min | Guía completa del patrón Registry |
|
|
| [docs/AGENDA_TOOLS_EXAMPLE.py](docs/AGENDA_TOOLS_EXAMPLE.py) | 15 min | 5 herramientas reales de ejemplo |
|
|
| [docs/REGISTRY_IMPLEMENTATION_SUMMARY.md](docs/REGISTRY_IMPLEMENTATION_SUMMARY.md) | 10 min | Resumen de implementación |
|
|
| [docs/README_REGISTRY.md](docs/README_REGISTRY.md) | 10 min | Resumen ejecutivo |
|
|
| [docs/TOOL_REGISTRY_GUIDE.md](docs/TOOL_REGISTRY_GUIDE.md) | 15 min | Patrones y mejores prácticas |
|
|
| [docs/CHANGES_SUMMARY.md](docs/CHANGES_SUMMARY.md) | 5 min | Qué cambió en el sistema |
|
|
|
|
## 🎯 Buscar rápidamente
|
|
|
|
**¿Cómo creo una tool?**
|
|
→ [docs/TOOLS_GUIDE.md](docs/TOOLS_GUIDE.md#2-crear-una-herramienta-personalizada)
|
|
|
|
**¿Cómo registro tools?**
|
|
→ [docs/TOOLS_GUIDE.md](docs/TOOLS_GUIDE.md#3-registrar-y-usar-herramientas)
|
|
|
|
**¿Qué métodos tiene ToolRegistry?**
|
|
→ [docs/TOOLS_GUIDE.md](docs/TOOLS_GUIDE.md#4-métodos-disponibles-del-toolregistry)
|
|
|
|
**¿Necesito ejemplos?**
|
|
→ [docs/AGENDA_TOOLS_EXAMPLE.py](docs/AGENDA_TOOLS_EXAMPLE.py)
|
|
|
|
**¿Cómo conecto con BD?**
|
|
→ [docs/TOOLS_GUIDE.md](docs/TOOLS_GUIDE.md#5-ejemplo-completo-herramienta-para-gestionar-agenda)
|
|
|
|
**¿Dónde escribo mis herramientas?**
|
|
→ `src/naliiabot/bot/tools/tools.py`
|
|
|
|
## ⏱️ Ruta rápida (20 minutos)
|
|
|
|
```
|
|
1. Lee: README.md (2 min)
|
|
2. Lee: docs/TOOLS_DOCUMENTATION_INDEX.md (10 min)
|
|
3. Sigue: docs/QUICK_START.py (5 min)
|
|
4. Listo: Ahora puedes crear tools ✅
|
|
```
|
|
|
|
## ✨ Beneficios del patrón Registry
|
|
|
|
✅ Centralizado
|
|
✅ Extensible
|
|
✅ Testeable
|
|
✅ Mantenible
|
|
✅ Escalable
|
|
✅ Validado
|
|
✅ Documentado
|
|
|
|
---
|
|
|
|
**Última actualización:** 15 Feb 2026
|