2 repositorios
Tools that replace static documentation with narrated, interactive paths directly within the source code editor.
Distinct from Documentation Automation: Distinct from documentation automation which focuses on CI/CD updates; this focuses on the interactive delivery format.
Explore 2 awesome GitHub repositories matching development tools & productivity · Interactive Code Documentation. Refine with filters or upvote what's useful.
Code Tour es una extensión de VS Code que permite la creación de recorridos guiados interactivos paso a paso de una base de código. Sirve como herramienta para la documentación guiada, mapeando explicaciones descriptivas directamente a líneas de archivo y directorios específicos dentro del editor para facilitar la incorporación (onboarding) y la transferencia de conocimiento técnico. El sistema se distingue por el uso de anclajes basados en expresiones regulares para mantener la estabilidad de los pasos entre diferentes versiones del código fuente, y por la capacidad de exportar los recorridos como archivos portátiles que contienen el contexto de código necesario para su reproducción sin el repositorio local original. Además, admite la sincronización con el control de versiones mediante el versionado de recorridos basado en Git y proporciona detección de deriva (drift) para identificar cuándo los cambios en el código rompen los enlaces de los recorridos existentes. El proyecto cubre una amplia gama de capacidades, incluyendo la grabación y diseño de recorridos, un motor de reproducción con descubrimiento basado en el margen (gutter) y la capacidad de incrustar elementos interactivos como comandos de shell e invocaciones de funciones del editor. Los recorridos se almacenan mediante serialización JSON y pueden compartirse a través de enlaces remotos o gestionarse mediante estrategias de almacenamiento en disco flexibles.
Integrates interactive tours and narrated code paths directly into the editor to replace static documentation.
Este proyecto es un recurso educativo que consiste en un currículo estructurado de notebooks interactivos diseñados para enseñar conceptos de deep learning y arquitecturas de redes neuronales. Se enfoca en proporcionar experiencia práctica con el framework TensorFlow 2 y la API Keras, guiando a los usuarios a través de ejercicios prácticos para dominar técnicas de machine learning. El repositorio se distingue por combinar contenido instructivo con los requisitos técnicos para computación de alto rendimiento. Incluye guías específicas para configurar entornos de desarrollo locales para soportar entrenamiento acelerado por hardware en unidades de procesamiento gráfico, asegurando que los estudiantes puedan realizar cálculos matemáticos intensivos para sus modelos. La plataforma soporta un rango de flujos de trabajo de desarrollo, desde el prototipado rápido de arquitecturas de redes neuronales hasta la ejecución de experimentos de ciencia de datos. Proporciona utilidades para renderizar ecuaciones matemáticas y código dentro de documentos, y acomoda tanto el desarrollo local offline como entornos de ejecución basados en la nube.
Encodes code, narrative text, and rich media into a structured format that allows for both human-readable documentation and executable program logic.