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
-
Locate Documentation and Readmes:
- Find all user guides, tutorials, and specifications under
docs/andspecification/. - Find the
README.mdfiles in each codebase directory.
- Find all user guides, tutorials, and specifications under
-
Audit Readme Commands and Configs:
- For each codebase directory, parse the
README.mdto 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.
- For each codebase directory, parse the