2 dépôts
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 est une extension VS Code qui permet de créer des visites guidées interactives et étape par étape d'une base de code. Il sert d'outil de documentation guidée, mappant des explications descriptives directement sur des lignes de fichiers et des répertoires spécifiques au sein de l'éditeur pour faciliter l'onboarding et le transfert de connaissances techniques. Le système se distingue par l'utilisation d'ancrages basés sur des expressions régulières pour maintenir la stabilité des étapes à travers différentes versions du code source, et par la capacité d'exporter les visites sous forme de fichiers portables contenant le contexte de code nécessaire pour une lecture sans le dépôt local original. Il prend également en charge la synchronisation avec le contrôle de version via le versionnage Git des visites et fournit une détection de dérive pour identifier quand les changements de code brisent les liens existants. Le projet couvre un large éventail de capacités, incluant l'enregistrement et la conception de visites, un moteur de lecture avec découverte via la gouttière (gutter) de l'éditeur, et la capacité d'intégrer des éléments interactifs tels que des commandes shell et des invocations de fonctions d'éditeur. Les visites sont stockées via sérialisation JSON et peuvent être partagées via des liens distants ou gérées via des stratégies de stockage sur disque flexibles.
Integrates interactive tours and narrated code paths directly into the editor to replace static documentation.
Ce projet est une ressource éducative consistant en un cursus structuré de notebooks interactifs conçus pour enseigner les concepts d'apprentissage profond et les architectures de réseaux de neurones. Il se concentre sur la fourniture d'une expérience pratique avec le framework TensorFlow 2 et l'API Keras, guidant les utilisateurs à travers des exercices pratiques pour maîtriser les techniques d'apprentissage automatique. Le dépôt se distingue en combinant le contenu pédagogique avec les exigences techniques pour le calcul haute performance. Il inclut des guides spécifiques pour configurer les environnements de développement locaux afin de prendre en charge l'entraînement accéléré par le matériel sur des unités de traitement graphique (GPU), garantissant que les apprenants peuvent effectuer des calculs mathématiques intensifs pour leurs modèles. La plateforme prend en charge une gamme de workflows de développement, du prototypage rapide d'architectures de réseaux de neurones à l'exécution d'expériences en science des données. Elle fournit des utilitaires pour rendre les équations mathématiques et le code au sein des documents, et elle s'adapte à la fois au développement local hors ligne et aux environnements d'exécution basés sur le cloud.
Encodes code, narrative text, and rich media into a structured format that allows for both human-readable documentation and executable program logic.