---
name: a2ui-doc-sync-check
description: Auditing codebase implementations for synchronization drift with the user documentation, readmes, and code comments.
metadata:
  internal: true
title: a2ui-doc-sync-check
canonical_url: https://skilld.dev/gh/a2ui-project/a2ui/a2ui-doc-sync-check
last_updated: 2026-11-13T20:07:16.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install a2ui-project/a2ui/a2ui-doc-sync-check`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/a2ui-doc-sync-check`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/a2ui-project/a2ui/a2ui-doc-sync-check) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/a2ui-doc-sync-check`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/a2ui-doc-sync-check --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/a2ui-doc-sync-check --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# 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.

3. **Audit Code-vs-Docs Public API and Settings**:
   - Make sure the glossary is respected. Verify that terms used in code, documentation and blueprints are consistent with [the glossary](../../../docs/site/src/content/docs/concepts/glossary.mdx). If you find deviations, suggest fixes. If you see an important term is used in documentation and/or API, but is missing from the glossary, suggest an update for the glossary.
   - Inspect the codebase's public API entrypoints (classes, interfaces, types, methods).
   - Compare them against any descriptions, structural maps, or code snippets in the `docs/` folder.
   - Look for renamed classes, changed signatures, or removed options that are still described in the docs.
   - If the codebase exposes new settings or flags that are undocumented in `docs/` or the spec guides, log them as missing documentation.

4. **Audit Inline Comments and Docstrings**:
   - Audit inline comments and docstrings (e.g. JSDoc in TS, docstrings in Python, triple-slash comments in Dart/Swift) for public APIs.
   - Flag any mismatch where code parameter names, types, return behaviors, or exceptions thrown deviate from what the docstring claims.

5. **Links and Duplicates**:
   - When an artifact (code, document, issue, PR, comment and so on) is referenced, make sure it has a link.
   - When a glossary term is used - link the first occurrence of the term to the glossary entry if it exists.
   - Make sure there is no duplications of content. If you find some, delete the duplicate and leave a reference.

6. **Conciseness and Clarity**:
   - Verify that documentation and code comments follow the [natural-writing](../natural-writing/SKILL.md) skill, and flag text that breaks its rules.

7. **Format the Report**:
   - Build a Markdown report summarizing the findings:
     - Table of audited directories.
     - **Documentation Drift**: Mismatches between documentation guides (`docs/`) and codebase implementations.
     - **Readme Errors**: Invalid setup, compile, or test commands found in `README.md` files.
     - **Docstring Mismatches**: Outdated parameter names or behaviors described in inline comments.
   - Return this Markdown report as your final response.
