2 Repos
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 ist eine VS Code-Erweiterung, die die Erstellung interaktiver, schrittweiser geführter Rundgänge durch eine Codebasis ermöglicht. Sie dient als Tool für geführte Code-Dokumentation, bei der beschreibende Erklärungen direkt mit bestimmten Dateizeilen und Verzeichnissen im Editor verknüpft werden, um das Onboarding in die Codebasis und den technischen Wissenstransfer zu unterstützen. Das System zeichnet sich durch die Verwendung von Regex-basiertem Anchoring aus, um die Stabilität der Schritte über verschiedene Versionen des Quellcodes hinweg zu wahren, sowie durch die Möglichkeit, Touren als portable Dateien zu exportieren, die den notwendigen Code-Kontext für die Wiedergabe ohne das ursprüngliche lokale Repository enthalten. Zudem unterstützt es die Synchronisierung mit der Versionskontrolle durch Git-basiertes Tour-Versioning und bietet eine Drift-Erkennung, um festzustellen, wann Codeänderungen bestehende Tour-Links unterbrechen. Das Projekt deckt ein breites Spektrum an Funktionen ab, darunter Tour-Aufzeichnung und -Design, eine Wiedergabe-Engine mit Gutter-basierter Erkennung sowie die Möglichkeit, interaktive Elemente wie Shell-Befehle und Editor-Funktionsaufrufe einzubetten. Rundgänge werden mittels JSON-Serialisierung gespeichert und können über Remote-Links geteilt oder über flexible, festplattenbasierte Speicherstrategien verwaltet werden.
Integrates interactive tours and narrated code paths directly into the editor to replace static documentation.
Dieses Projekt ist eine Bildungsressource, die aus einem strukturierten Lehrplan interaktiver Notebooks besteht, die Deep-Learning-Konzepte und neuronale Netzwerkarchitekturen vermitteln sollen. Es konzentriert sich auf die Bereitstellung praktischer Erfahrungen mit dem TensorFlow 2-Framework und der Keras-API und führt Benutzer durch praktische Übungen zur Beherrschung von Machine-Learning-Techniken. Das Repository zeichnet sich durch die Kombination von instruktiven Inhalten mit den technischen Anforderungen für High-Performance-Computing aus. Es enthält spezifische Anleitungen zur Konfiguration lokaler Entwicklungsumgebungen zur Unterstützung hardwarebeschleunigten Trainings auf Grafikprozessoren, um sicherzustellen, dass Lernende intensive mathematische Berechnungen für ihre Modelle durchführen können. Die Plattform unterstützt eine Reihe von Entwicklungs-Workflows, vom Rapid Prototyping neuronaler Netzwerkarchitekturen bis zur Ausführung von Data-Science-Experimenten. Sie bietet Utilities zum Rendern mathematischer Gleichungen und Code innerhalb von Dokumenten und unterstützt sowohl lokale Offline-Entwicklung als auch Cloud-basierte Ausführungsumgebungen.
Encodes code, narrative text, and rich media into a structured format that allows for both human-readable documentation and executable program logic.