docs: add real terminal demo and quick start to README - #5
Merged
Conversation
Fase 1 (traccion) del plan: convertir visitantes en usuarios mostrando QUE hace el toolkit, no solo que ES. - 'See it in action': demo real capturada ejecutando ai-toolkit doc con Ollama local (qwen2.5-coder:1.5b) sobre un archivo de ejemplo. Incluye antes/despues: userService.ts sin docs -> DOCS.md con JSDoc. - 'Quick Start': escenario concreto de ahorro de tiempo (repo legacy de 50 archivos, ~4h manuales) + flujo de 1 comando + tip de Ollama gratuito sin API key. - Header nav actualizado con los nuevos anchors. Sin cambios de codigo: solo documentacion. Sin tests afectados.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Qué cambia
Demo visible + quick start en el README (Fase 1 del plan de tracción).
ai-toolkit doccon Ollama local) + antes/después de un archivo real.Verificación
userService.ts→DOCS.mdcon JSDoc generado automáticamente