5 repositorios
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 is a Go-based command line utility used for documenting, analyzing, and linting relational database schemas. It functions as a documentation tool that generates structured reports and entity-relationship diagrams in Markdown, JSON, or Excel formats, as well as a schema diff tool for identifying discrepancies between a live database and its documentation. The project allows for schema augmentation and the definition of virtual relationships through external configuration files, enabling metadata overrides and table connections without requiring database migrations or native constraints. I
Calculates the percentage of tables and columns that possess descriptions to measure documentation coverage.
Compodoc es un generador de documentación de API para TypeScript, generador de sitios estáticos y visualizador de arquitectura de proyectos. Analiza el código fuente y los comentarios JSDoc para crear sitios de referencia técnica, catálogos de API y páginas HTML independientes que se pueden buscar. El proyecto se distingue por analizar las sentencias de importación para producir grafos de dependencia y mapas de módulos que ilustran las relaciones estructurales dentro de una base de código. Incluye soporte especializado para visualizar proyectos Angular, flujos de trabajo NestJS y componentes web Stencil, y puede incrustar demos funcionales en vivo directamente en las páginas de documentación. El sistema también funciona como un analizador de cobertura de documentación, proporcionando informes y aplicando umbrales mínimos de cobertura dentro de pipelines de integración continua para fallar builds si los niveles de documentación son insuficientes. Las capacidades adicionales incluyen integración con markdown, exportación de datos en múltiples formatos a JSON o Markdown, y un servidor de desarrollo local con monitoreo del sistema de archivos para reconstrucciones automáticas. Los usuarios pueden personalizar la salida a través de archivos de configuración, estilos CSS personalizados y filtrado de visibilidad de elementos para excluir símbolos específicos o etiquetas internas del sitio final.
Calculates the percentage of documented code and provides reports on documentation gaps.