source-of-truth-sync

Propagate source file edits to contract documentation and CLAUDE.md.

Updated Jan 5, 2026
One-click install
npx skills add https://github.com/Maxcogar/agent-armory --skill source-of-truth-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: source-of-truth-sync
Source: https://github.com/Maxcogar/agent-armory/tree/main/workflows/codebase-documentation/source-of-truth-sync
Command: npx skills add https://github.com/Maxcogar/agent-armory --skill source-of-truth-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Auto-syncs contract documents and CLAUDE.md with edited source files to maintain source-of-truth alignment across the codebase.

Core Features & Use Cases

  • Identify changes in source files
  • Update corresponding contract docs and CLAUDE.md sections
  • Cross-check and verify consistency across artifacts

Quick Start

Run the automated source-of-truth sync after editing any contract-paired source file to refresh docs and CLAUDE.md sections.

Frequently Asked Questions about source-of-truth-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep contract docs in sync with source code changes?

To keep contract docs in sync with source code changes, you can run an automated source-of-truth sync that identifies edits in source files and propagates them to corresponding contract documentation.

How does CLAUDE.md documentation alignment work when source files are edited?

CLAUDE.md documentation alignment works by detecting changes in edited source files and automatically updating the relevant CLAUDE.md sections to maintain source-of-truth consistency across the codebase.

What is the best way to update documentation after editing state machines and schemas?

The best way to update documentation after editing state machines and schemas is to use an automated docs-sync process that cross-checks and verifies consistency across all paired contract artifacts.

Can I automatically update route and websocket contract docs from source file edits?

Yes, you can automatically update route and websocket contract docs by running a source-of-truth sync that detects source file edits and propagates those changes to the applicable contract documentation.

Does source-of-truth documentation sync require a specific codebase structure?

Source-of-truth documentation sync applies to codebases that already contain contract maps, docs contracts, and CLAUDE.md sections to ensure automated updates and cross-check validation steps can be performed.

Why do my contract docs become inconsistent after updating source files?

Contract docs become inconsistent after updating source files when changes to state machines, schemas, routes, or websocket contracts are not automatically propagated to the corresponding documentation artifacts.