Skip to content
Back to skills

Docs Auto Sync

ASecurity

Automatically update repository documentation whenever code changes (add/edit/refactor) occur. Use when modifying source code, public APIs/contracts, rendering/interaction/data/compute logic, diagnostics, or build/release/CI flows so docs stay consistent without asking.

  • 666 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added February 8, 2026
documentationapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned February 12, 2026

npx -y skills add majiayu000/claude-skill-registry --skill docs-auto-sync --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Docs Auto Sync?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Docs Auto Sync
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/majiayu000-docs-auto-sync/badge)](https://www.skillsdirectory.com/skills/majiayu000-docs-auto-sync)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: docs-auto-sync
description: Automatically update repository documentation whenever code changes (add/edit/refactor) occur. Use when modifying source code, public APIs/contracts, rendering/interaction/data/compute logic, diagnostics, or build/release/CI flows so docs stay consistent without asking.
---

# Docs Auto Sync

## Overview
Keep documentation in sync with code changes by updating the required docs in the same change set. Default to automatic updates; only ask if a required detail is missing.

## Workflow
1. Classify the change scope.
- Identify layers touched (core/rendering/interaction/data/compute/api/diagnostics/ci/packaging).
- Note any contract, lifecycle, or budget changes (see `AGENTS.md`).

2. Choose docs to update.
- Use `references/doc-impact-matrix.md` to map change types to docs.
- If multiple layers are touched, add a short design note per `AGENTS.md`.
- For contract changes, add version notes and a migration note.

3. Update docs automatically.
- Apply edits in the same change set.
- Add a rationale to any new doc: why it belongs in chart-engine and not quant-lab.
- Keep cross-links and references consistent.

4. Validate before final response.
- Ensure doc DoD: cross-links updated, invariants/SLOs referenced, version notes added.
- Summarize which docs were updated and why.

## Resources
- `references/doc-impact-matrix.md` - change types and required docs.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.