5 dépôts
Analysis of code changes to determine if new public surfaces are adequately documented.
Distinct from Code Coverage: Analyzes documentation gaps based on code changes, distinct from measuring test suite code coverage
Explore 5 awesome GitHub repositories matching part of an awesome list · Documentation Coverage Analysis. Refine with filters or upvote what's useful.
gstack is an AI agent framework and development workflow system designed to automate the software development lifecycle. It coordinates specialized AI personas to manage tasks across product design, engineering management, and quality assurance, transforming product intent into technical specifications and final releases. The project is distinguished by its deep integration of headless browser automation and semantic code memory. It utilizes a persistent Chromium daemon for web scraping and visual auditing, and implements a searchable knowledge base that logs architectural decisions and repos
Identifies undocumented public surfaces by analyzing code diffs against required documentation types.
TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface. The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes. Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It support
Validates that all exported symbols have descriptions and treats missing documentation as build errors.
Jazzy is a source code documentation tool and API generator designed for Swift and Objective-C. It analyzes project roots and compiled modules to produce searchable HTML websites or offline docsets. The system functions as a multi-module API documenter, aggregating documentation from separate source modules into a single site with cross-module linking. It serves as a markdown-based documentation engine that integrates technical guides and LaTeX mathematical equations to complement generated API references. The tool covers a broad capability surface including multi-language API generation for
Tracks the percentage of documented symbols to analyze documentation gaps and generate coverage badges.
tbls est un utilitaire en ligne de commande basé sur Go utilisé pour documenter, analyser et linter les schémas de bases de données relationnelles. Il fonctionne comme un outil de documentation qui génère des rapports structurés et des diagrammes entité-relation aux formats Markdown, JSON ou Excel, ainsi qu'un outil de diff de schéma pour identifier les écarts entre une base de données en direct et sa documentation. Le projet permet l'augmentation de schéma et la définition de relations virtuelles via des fichiers de configuration externes, permettant des remplacements de métadonnées et des connexions de tables sans nécessiter de migrations de base de données ou de contraintes natives. Il prend en outre en charge l'organisation des tables en points de vue basés sur le domaine pour créer des perspectives organisées du schéma global. Les capacités supplémentaires incluent la capacité de valider les structures de base de données par rapport à des règles prédéfinies via un linter SQL et la mesure de la couverture documentaire pour déterminer le pourcentage de tables et de colonnes décrites. Le système utilise une interface de pilote basée sur JSON pour intégrer des exécutables externes afin de prendre en charge divers types de bases de données et emploie des modèles personnalisables pour la génération de documents.
Calculates the percentage of tables and columns that possess descriptions to measure documentation coverage.
Compodoc est un générateur de documentation API TypeScript, un générateur de site statique et un visualiseur d'architecture de projet. Il analyse le code source et les commentaires JSDoc pour créer des sites de référence technique consultables, des catalogues API et des pages HTML autonomes. Le projet se distingue par l'analyse des instructions d'importation pour produire des graphes de dépendances et des cartes de modules illustrant les relations structurelles au sein d'une base de code. Il inclut un support spécialisé pour la visualisation de projets Angular, de flux de travail NestJS et de composants web Stencil, et peut intégrer des démos fonctionnelles directement dans les pages de documentation. Le système fonctionne également comme un analyseur de couverture de documentation, fournissant des rapports et imposant des seuils de couverture minimaux au sein des pipelines d'intégration continue pour faire échouer les builds si les niveaux de documentation sont insuffisants. Les capacités supplémentaires incluent l'intégration Markdown, l'exportation de données multi-format vers JSON ou Markdown, et un serveur de développement local avec surveillance du système de fichiers pour des reconstructions automatiques. Les utilisateurs peuvent personnaliser la sortie via des fichiers de configuration, des styles CSS personnalisés et le filtrage de visibilité des éléments pour exclure des symboles spécifiques ou des balises internes du site final.
Calculates the percentage of documented code and provides reports on documentation gaps.