a2ui-doc-sync-check

Installation
SKILL.md

A2UI Code and Documentation Synchronization Check Skill

This skill guides the process of auditing concrete codebase implementations to verify that they are synchronized with their respective documentation files, codebase READMEs, and inline code comments/docstrings.


Instructions

  1. Locate Documentation and Readmes:

    • Find all user guides, tutorials, and specifications under docs/ and specification/.
    • Find the README.md files in each codebase directory.
  2. Audit Readme Commands and Configs:

    • For each codebase directory, parse the README.md to extract setup commands, dependencies, build/test commands, and directory layouts.
    • Cross-reference these details with the codebase's project files (e.g. package.json, pyproject.toml, pubspec.yaml, Package.swift).
    • If any command listed in the readme is invalid, deprecated, or has wrong arguments, list it as a discrepancy.
Installs
3
GitHub Stars
17.3K
First Seen
Jul 27, 2026