documentation-nag

Community

Keep docs synchronized with code changes

Authorsaxonthune
Version1.0.0
Installs0

System Documentation

What problem does it solve?

It prevents documentation from drifting out of sync with the codebase after changes, so teams and AI agents can trust what the docs say.

Core Features & Use Cases

  • Change-scoped analysis: Uses a dedicated analysis script to identify what changed (by package and new/removed exports/hooks/components) and scopes which docs to verify.
  • Manifest-driven doc mapping: Reads the workspace MANIFEST tag index to map code-change areas to the specific documentation refs that should be checked.
  • Content-based doc-vs-code reconciliation: Reads docs holistically, then spot-checks the corresponding code to detect missing features, outdated behavior, and incomplete tables.
  • Always-on reconciliation: Reconciles barrel-file export tables and MCP tool registrations against what the relevant architecture/tool inventory docs claim, even when Phase 1 didn’t indicate changes.

Quick Start

Use the documentation-nag skill in the Carta workspace to analyze recent code changes, verify the affected .carta documentation via MANIFEST mappings, and generate precise edit instructions (including evidence and section targets) for updating stale docs.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documentation-nag
Download link: https://github.com/saxonthune/carta/archive/main.zip#documentation-nag

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.