10 个仓库
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 是一个 Markdown 文档标准和规范,旨在组织项目元数据和说明。它作为一个开源治理框架,建立了一套正式的规则和模板,以确保项目信息在不同仓库中保持可预测性和一致性。 该项目提供了一个文档合规性验证器,用于检查 README 是否符合这些预定义的格式标准。它包括用于生成 README 模板以产生基准文档文件的工具,以及通过使用视觉徽章来标记规范合规性的系统。
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 是一个用于在 TypeScript 代码中编写结构化注释的文档标准和规范。它提供了一个可移植的系统,用于在源代码中定义元数据、标签和交叉引用,以确保在不同工具链之间实现一致的解析和渲染。 该项目包含一个文档注释解析器,可将注释转换为结构化语法树,以及一个强制执行语法一致性的验证器。它允许通过外部配置文件定义自定义文档标签,并支持多种语法验证模式以协助规范合规性。 该规范涵盖了广泛的 API 文档需求,包括标记发布阶段、稳定性和弃用状态。它支持详细说明函数参数、返回值和异常类型,以及管理内部可见性、继承和声明之间的交叉引用。
Enforces syntax consistency and validates doc comment adherence to the TSDoc formal specification.