smithery.ai

doc-sync-validator

Ensures code changes in src/ are reflected in the product documentation within docs/en/product/.

First seen Mar 23, 2026

Installation

$ npx skills add https://smithery.ai

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery.ai · top by installs.

npx skills add https://smithery.ai

Browse all from smithery.ai

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,344 B
  • docs SUMMARY.md 122 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 2 installs

SKILL.md

Documentation Sync Protocol

1. Context Mapping

The project uses a docs_manifest.yaml to map source code modules to their corresponding documentation files.

2. Validation Logic

Whenever changes are detected in the src/ directory:

  1. Analyze Diff: Identify which modules or functions were modified.
  2. Manifest Check: Cross-reference the modified paths against docs_manifest.yaml.
  3. Parity Audit:

- Check if the corresponding .md files in docs/en/product/ have been modified in the current staged changes. - If code was added/changed but documentation was not, flag a Sync Warning.

3. Agent Instructions

  • If a drift is detected, do not block the commit immediately. Instead, present a summary:

> "⚠️ Source change detected in src/auth/ but docs/en/product/auth-flow.md was not updated. Would you like me to draft the documentation update now?"

  • If the user says "No," proceed but log the drift in PROJECT_STATE.md under a "Technical Debt" section.

4. Exit Criteria

  • Pass (0): Code and Docs are both updated, or no source changes were detected.
  • Review (1): Source changed without documentation update (requires user bypass).