5 repository-uri
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 este un utilitar de linie de comandă bazat pe Go utilizat pentru documentarea, analizarea și linting-ul schemelor de baze de date relaționale. Acesta funcționează ca un instrument de documentare care generează rapoarte structurate și diagrame entitate-relație în formate Markdown, JSON sau Excel, precum și un instrument de diff pentru scheme pentru identificarea discrepanțelor dintre o bază de date live și documentația sa. Proiectul permite augmentarea schemei și definirea relațiilor virtuale prin fișiere de configurare externe, permițând suprascrieri de metadate și conexiuni între tabele fără a necesita migrarea bazei de date sau constrângeri native. De asemenea, suportă organizarea tabelelor în puncte de vedere bazate pe domeniu pentru a crea perspective curatoriate ale schemei generale. Capabilitățile suplimentare includ capacitatea de a valida structurile bazei de date în raport cu reguli predefinite printr-un linter SQL și măsurarea acoperirii documentației pentru a determina procentul de tabele și coloane descrise. Sistemul utilizează o interfață de driver bazată pe JSON pentru a integra executabile externe pentru suportul diverselor tipuri de baze de date și utilizează șabloane personalizabile pentru generarea documentelor.
Calculates the percentage of tables and columns that possess descriptions to measure documentation coverage.
Compodoc este un generator de documentație API TypeScript, generator de site-uri statice și vizualizator de arhitectură de proiect. Acesta analizează codul sursă și comentariile JSDoc pentru a crea site-uri de referință tehnică căutabile, cataloage API și pagini HTML independente. Proiectul se distinge prin analizarea instrucțiunilor de import pentru a produce grafuri de dependență și hărți de module care ilustrează relațiile structurale dintr-un codebase. Include suport specializat pentru vizualizarea proiectelor Angular, fluxurilor de lucru NestJS și componentelor web Stencil, și poate încorpora demo-uri live direct în paginile de documentație. Sistemul funcționează, de asemenea, ca un analizor de acoperire a documentației, oferind rapoarte și impunând praguri minime de acoperire în cadrul pipeline-urilor de integrare continuă pentru a eșua build-urile dacă nivelurile de documentație sunt insuficiente. Capabilitățile suplimentare includ integrarea Markdown, exportul de date în formate multiple (JSON sau Markdown) și un server de dezvoltare local cu monitorizarea sistemului de fișiere pentru reconstrucții automate. Utilizatorii pot personaliza output-ul prin fișiere de configurare, stilizare CSS personalizată și filtrarea vizibilității elementelor pentru a exclude simboluri specifice sau tag-uri interne din site-ul final.
Calculates the percentage of documented code and provides reports on documentation gaps.