Skip to main content
command CX Codex

docs-sync — Claude Code command: verify documentation matches code

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.

no license ★ 6,091 updated 2026-01-06

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/commands/docs-sync.md
Open on GitHub

What docs-sync 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.

What it helps with

  • 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 for the agent

  • 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

How to install docs-sync

Manually: put the files in place

.claude/commands/docs-sync.md

Call it with /docs-sync. For all projects use ~/.claude/commands/

Questions about docs-sync

How do I install docs-sync in Claude Code?

Place the docs-sync.md file in your project's .claude/commands/ directory.

What does docs-sync do?

It identifies TypeScript code changed in the past month, locates corresponding documentation, and reports inaccuracies. Output is a checklist of docs that need revision.

Which files does docs-sync check?

It examines TypeScript files (*.ts, *.tsx), then searches for documentation in /docs/, README files near changed code, and TSDoc comments within the source files themselves.

Similar slash commands

All slash commands for Code review and refactoring →

From the same set11

The whole set →
pr-summary pr-summary reviews the current branch against main and drafts a pull request body with changed files, breaking changes, and a test checklist. CX Codex +1 ★ 6,091repo stars onboard onboard — a command that prepares an agent to work on a project. It explores the codebase, asks clarifying questions, and records context for the next session. CX Codex +1 ★ 6,091repo stars pr-review pr-review inspects pull requests through the GitHub CLI against project standards and posts tiered review notes. CX Codex +1 ★ 6,091repo stars code-quality code-quality reviews TypeScript files in a chosen directory, runs npm checks, and groups findings by severity. Use it before a code change or review. CX Codex +1 ★ 6,091repo stars github-workflow github-workflow manages Git branches, Conventional Commits, and pull requests according to team conventions. Helpful for keeping repository history structured and tidy. CX Codex ★ 6,091repo stars ticket Handles the full ticket workflow: fetch task details from JIRA or Linear, explore related code, implement changes, and create a linked PR. Reduces manual sync between issue tracker and repository. CX Codex +1 ★ 6,091repo stars code-reviewer code-reviewer — a subagent for Claude Code that checks newly written or modified code against project standards, TypeScript strict mode, and security patterns. CX Codex ★ 6,091repo stars systematic-debugging systematic-debugging enforces a four-phase troubleshooting protocol rooted in root cause analysis. Ideal for tracking down broken test suites or runtime errors without trial-and-error edits. CX Codex +1 ★ 6,091repo stars

Project sponsors

Companies that keep this analytics open