/doc-from-code
Convierte código en docs sin perder horas.
Usage
/doc-from-code <file-or-folder>
/doc-from-code src/lib --output docs/api.md
/doc-from-code --format=mdx # para Docusaurus/Nextra
Qué extrae
Para cada export
- Signature con tipos
- Description del docstring/JSDoc
- Parameters con descripciones
- Returns con tipo y significado
- Throws / Errors posibles
- Example (genera uno realista si no existe)
Para módulos
- Overview (1 párrafo)
- Lista de exports con links
- Ejemplo end-to-end de uso típico
Formatos
- Markdown (default)
- MDX (con código embebido)
- HTML (vía pandoc)
- JSON (para procesar después)
Convenciones detectadas
- JSDoc / TSDoc (TypeScript/JavaScript)
- Docstrings (Python — Google, NumPy, Sphinx)
- Doc comments (Rust, Go, Swift)
- KDoc (Kotlin)
Heurísticas
- Si una función no tiene comments, infiere descripción del nombre + tipos
- Marca con ⚠️ las que necesitan revisión manual
- Genera un
coverage.jsoncon qué exports tienen docs y cuáles no