10 repositorios
Tools that check comments and documentation files for spelling, grammar, and formatting errors.
Distinct from Code Documentation Standards: Distinct from Code Documentation Standards: focuses on automated validation tools rather than guidelines.
Explore 10 awesome GitHub repositories matching software engineering & architecture · Documentation Validators. 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
Triggers build failures when invalid paths, missing images, or oversized files are detected in documentation.
This project is a comprehensive, curated directory of static analysis, linting, and security scanning utilities. It serves as a central resource for developers to discover, compare, and select tools based on specific programming languages, licensing models, and integration requirements. The directory distinguishes itself by providing deep metadata for each listed utility, including community-driven popularity rankings, maintenance status, and deployment methods. By aggregating these tools into a single searchable index, it enables teams to identify solutions for enforcing coding standards, ma
Checks source code comments and documentation for errors to maintain professional standards.
This project is a static analysis linter, code quality tool, and language auditor for Rust. It functions as an automated refactoring system designed to identify common mistakes and suggest idiomatic improvements for Rust source code. The tool identifies non-idiomatic patterns, performance bottlenecks, and code smells to improve the overall correctness and quality of the code. It specifically audits memory safety by flagging suspicious use of unsafe blocks and pointer manipulations and detects inefficient operations to optimize execution speed. The analysis surface covers coding style enforce
Checks documentation comments for broken links, missing punctuation, and formatting errors.
Great Expectations is a data quality testing framework and observability platform designed to monitor the reliability of data pipelines. It provides a structured environment for defining, documenting, and automating data quality assertions, allowing teams to validate datasets against expected structure and content before they move through downstream processes. The project distinguishes itself through a declarative domain-specific language that stores quality rules as version-controlled configuration files. It utilizes an execution engine abstraction to translate these high-level assertions in
Generates human-readable documentation from validation rules to provide transparency into expected data quality.
Checkstyle is a Java static analysis tool and linter designed to identify and enforce coding standards and best practices. It functions as a code quality auditor and Javadoc validation tool, checking source code against configurable rulesets to ensure structural and stylistic consistency. The project allows for the creation of custom linting rules by extending a core API to inspect the abstract syntax tree. It further enables specialized validation through the use of XPath expressions to query the syntax tree for specific code patterns and violations. Capability areas include the enforcement
Verifies that methods include tags for parameters and return values to ensure completeness.
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 exported TypeScript members have descriptions, treating missing documentation as build errors.
Markdoc is a documentation content framework that extends standard Markdown with custom tags, typed schemas, and reusable components, parsing content into an abstract syntax tree and rendering it as React elements or HTML. It provides a structured authoring system where documents are processed through an AST-based pipeline, enabling validation, transformation, and flexible output generation. The framework distinguishes itself through a schema-driven validation pipeline that checks document structure and attribute values against defined rules, and a pluggable renderer architecture that accepts
Checks documents for correctness separately from the rendering pipeline using custom rules.
Standard README es un estándar de documentación markdown y una especificación diseñada para organizar metadatos e instrucciones de proyectos. Funciona como un framework de gobernanza de código abierto que establece un conjunto formal de reglas y plantillas para asegurar que la información del proyecto permanezca predecible y consistente en diferentes repositorios. El proyecto proporciona un validador de cumplimiento de documentación para comprobar si un README cumple con estos estándares de formato predefinidos. Incluye herramientas para la generación de plantillas README para producir archivos de documentación base y un sistema para señalar el cumplimiento de la especificación mediante el uso de insignias visuales.
Checks project README files against a specific standard to identify missing sections and maintain quality.
envconfig is a Go configuration decoder and environment variable mapper that deserializes environment variables into structured Go data types. It provides tools for validating mandatory fields and ensuring application configuration adheres to the external configuration patterns of twelve-factor app compliance. The library features a help generator that creates formatted usage text based on struct definitions to describe expected environment variables. It also includes a validation tool capable of detecting unused environment variables that match a specific prefix but do not correspond to any
Generates formatted help text describing expected environment variables based on configuration struct definitions.
TSDoc es un estándar de documentación y especificación para escribir comentarios estructurados en código TypeScript. Proporciona un sistema portátil para definir metadatos, etiquetas y referencias cruzadas dentro del código fuente para garantizar un análisis y renderizado consistentes en diferentes herramientas. El proyecto incluye un analizador de comentarios de documentación que convierte los comentarios en un árbol de sintaxis estructurado y un validador que aplica la consistencia de la sintaxis. Permite la definición de etiquetas de documentación personalizadas a través de archivos de configuración externos y admite múltiples modos de validación de sintaxis para ayudar con el cumplimiento de la especificación. La especificación cubre una amplia gama de necesidades de documentación de API, incluyendo el marcado de etapas de lanzamiento, estabilidad y obsolescencia. Admite detallar parámetros de funciones, valores de retorno y tipos de excepciones, así como gestionar la visibilidad interna, la herencia y las referencias cruzadas entre declaraciones.
Enforces syntax consistency and validates doc comment adherence to the TSDoc formal specification.