ct-docs-sync

Detect and remediate documentation drift across scripts, COMMANDS-INDEX.json, README, and vision documents.

160|20|Updated Dec 6, 2025
One-click install
npx skills add https://github.com/kryptobaseddev/cleo --skill ct-docs-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ct-docs-sync
Source: https://github.com/kryptobaseddev/cleo/tree/main/dev/skills/ct-docs-sync
Command: npx skills add https://github.com/kryptobaseddev/cleo --skill ct-docs-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, and includes scripts (resource) and references (resource) components.

What problem does it solve?

CLEO canonical documentation tends to drift from the implemented commands and system architecture. This Skill ensures canonical sources and public-facing references stay aligned, reducing discrepancies across updates and releases.

Core Features & Use Cases

  • Drift detection across scripts, COMMANDS-INDEX.json, README.md, and vision documents to maintain a single source of truth.
  • Automated guidance and action items to align docs with code and system architecture.
  • Periodic checks during development and release cycles to ensure documentation accuracy for users and agents.

Quick Start

Run the drift detection script to verify alignment: ./dev/skills/ct-docs-sync/scripts/detect-drift.sh

Frequently Asked Questions about ct-docs-sync

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

FAQPage Schema
How do I detect documentation drift in my project?

Documentation drift is detected by running a bash script that compares source truth files against user-facing references. The skill reads core files under scripts/ and docs/ to report mismatches across COMMANDS-INDEX.json, README, and vision documents.

What is documentation drift and when do I need to check for it?

Documentation drift happens when canonical docs become inconsistent with implemented commands and system architecture. You need to check for it during development and release cycles to ensure documentation accuracy for both users and agent workflows.

Do I need jq installed to run bash documentation validation?

Yes, jq is required to run the bash documentation validation scripts. It is the only dependency needed to execute the drift detection process and parse the JSON configuration files.

How do I configure drift detection checks for my registry and scripts?

Drift detection checks are configured using a drift-config.json file. This file defines the specific validation rules that the bash script uses to align source truth with developer and user-facing documentation.

What's the best way to keep documentation aligned with code during releases?

The best way to keep documentation aligned is running automated drift detection across scripts, indices, and vision documents. This ensures a single source of truth and provides automated guidance to remediate discrepancies before releases.