chore: añade directorio dev/ con issues y funciones implementadas
Tracking de issues completados (jupyter tools) y funciones implementadas (specs de diseño ya resueltas).
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
# Documentación consolidada de herramientas Jupyter
|
||||
|
||||
**Componente:** `python/functions/notebook/`
|
||||
|
||||
## Problema
|
||||
|
||||
Las 5 funciones jupyter (`discover`, `read`, `exec`, `write`, `kernel`) tienen su documentación distribuida entre:
|
||||
- El `--help` de cada script
|
||||
- La sección de `CLAUDE.md` del proyecto raíz
|
||||
- Los `.md` de frontmatter de cada función
|
||||
|
||||
No hay un documento único que explique el flujo completo, casos de uso comunes, y troubleshooting. Esto dificulta tanto el uso por agentes como por humanos.
|
||||
|
||||
## Solución propuesta
|
||||
|
||||
Crear una función de tipo `documentation` o un .md dedicado que incluya:
|
||||
|
||||
1. **Flujo típico**: discover → read → write/exec (con ejemplo completo)
|
||||
2. **Tabla de subcomandos** por función con parámetros y ejemplos
|
||||
3. **Troubleshooting**: errores comunes y soluciones
|
||||
- Websocket 4404 (notebook no existe)
|
||||
- Kernel does not exist (sesión stale)
|
||||
- Document not yet synced (timing de colaboración)
|
||||
4. **Limitaciones conocidas**: qué NO pueden hacer las funciones
|
||||
5. **Diferencias con MCP jupyter**: por qué estas funciones lo reemplazan
|
||||
|
||||
## Ubicación sugerida
|
||||
|
||||
`python/functions/notebook/README.md` o bien una función `jupyter_help_py_notebook` que imprima la guía.
|
||||
Reference in New Issue
Block a user