# docs-sync

docs-sync is a Claude Code command that compares documentation with recent code changes and flags inconsistencies. It catches outdated examples, incorrect API signatures, and mismatched parameter types.

- command · `type=command` · Claude Code, Codex, GitHub Copilot, Gemini CLI · ★ 6091 repo stars
- Author: ChrisWiles
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/ChrisWiles/claude-code-showcase/tree/HEAD/.claude/commands/docs-sync.md
- Updated: 2026-01-06
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/commands/docs-sync

## What it does

docs-sync scans Git commits from the past month, identifies changed files, and locates related documentation in `/docs/`, README files near the code, and TSDoc comments. It then verifies that code examples are still valid, function descriptions match the implementation, and property types are current.

The command relies on Git to fetch the list of modified files via `git log` and cross-references them with documentation. Output is a checklist of what needs updating. Unlike a general docs search, it reports only genuine errors and avoids suggesting documentation for its own sake.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/commands/docs-sync.md` — Call it with /docs-sync. For all projects use ~/.claude/commands/

### Codex

**Manually: put the files in place**
- File: `~/.codex/prompts/docs-sync.md` — Call it with /prompts:docs-sync. Codex marks this format deprecated in favour of skills

### GitHub Copilot

**Manually: put the files in place**
- File: `.github/prompts/docs-sync.prompt.md`

### Gemini CLI

**Manually: put the files in place**
- File: `.gemini/commands/docs-sync.toml` — Gemini stores commands as TOML: the prompt text goes into the prompt field

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/ChrisWiles/claude-code-showcase/tree/HEAD/.claude/commands/docs-sync.md

## When to use it
- spot outdated code examples after refactoring
- catch misalignment between API implementation and its description
- verify parameter types in docs match the actual function signature
- compile a list of documentation to refresh following code updates

## Example prompts
- Check if documentation is in sync with recent code changes
- What do I need to update in the docs after these changes?
- Compare the docs against the latest code modifications

## Similar
- [docs-sync-audit](https://affpapa.org/en/nevibecode/skills/docs-sync-audit.md) — skill · 68 installs
- [sync](https://affpapa.org/en/nevibecode/commands/florianbruniaux-sync.md) — command · ★ 6529 repo stars
- [docs-updater](https://affpapa.org/en/nevibecode/skills/docs-updater.md) — skill · 3700 installs
- [docs-curator](https://affpapa.org/en/nevibecode/agents/docs-curator.md) — subagent · ★ 1472 repo stars
- [update-project-docs](https://affpapa.org/en/nevibecode/skills/update-project-docs.md) — skill · ★ 1198 repo stars
- [docs-guard](https://affpapa.org/en/nevibecode/skills/docs-guard.md) — skill · 4200 installs

From the same set: [chriswiles/claude-code-showcase](https://affpapa.org/en/nevibecode/by/chriswiles/claude-code-showcase.md) — 11 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
