Detects and updates documentation that has drifted from the actual code implementation.
npx skills add https://github.com/mjun0812/skills --skill doc-sync-mjun0812
Please help me install this Agent Skill. Skill: doc-sync Source: https://github.com/mjun0812/skills/tree/main/skills/docs/doc-sync Command: npx skills add https://github.com/mjun0812/skills --skill doc-sync-mjun0812
--dry-run flag reports detected divergences with before/after previews without modifying any files. - Use Case: After renaming CLI flags and adding a required API field, run the Skill on the repo to find every stale reference in README.md and docs/api.md and rewrite them to match the current implementation. ## Quick Start Ask the AI to check the repository documentation against the current implementation and update any outdated sections, optionally with --dry-run to preview changes first.High-intent search queries and answers about installing and using this skill.
Run the doc-sync skill against your repository to scan Markdown files, docstrings, OpenAPI specs, and example configs, then cross-check them against the actual code. It reports every divergence organized by file and section before applying updates.
Use the --dry-run flag, for example /doc-sync --dry-run. The skill detects divergences and shows before/after previews of each proposed change without calling any edit or write operations.
Yes, pass a path argument such as /doc-sync docs/api/ or /doc-sync README.md to limit the scan and update scope. This is recommended for large repositories and monorepos where each package has independent documentation.
It detects endpoint and schema divergences in openapi.yaml, openapi.json, and swagger files. However, if the spec is auto-generated from code by tools like zod-to-openapi, it skips updating and notifies you instead.
No, it only fixes factually incorrect content and preserves the original language, tone, heading levels, and formatting. Translation happens only when you explicitly pass a language argument.
The skill skips divergences where implementation intent is ambiguous and reports them for manual review. It also never commits changes, excludes directories like node_modules and .git, and avoids auto-generated OpenAPI schemas.
paperclipaiAudit project documentation against git history to detect and resolve factual drift.
swishstarSync non-gitignored local changes to the main branch on GitHub.
apokamoAutomate documentation updates for docs-only issues with consistency checks.
RajuNaikGenerate OpenAPI specifications and endpoint documentation from source code.