e2e-doc-sync

Syncs changed E2E plugin source files with documentation to detect gaps via diff-aware inventory and live probe verification.

3|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/iamcxa/kc-claude-plugins --skill e2e-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: e2e-doc-sync
Source: https://github.com/iamcxa/kc-claude-plugins/tree/main/e2e-pipeline/skills/e2e-doc-sync
Command: npx skills add https://github.com/iamcxa/kc-claude-plugins --skill e2e-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill detects and closes documentation gaps for e2e-pipeline skills and agents after code changes, ensuring docs accurately reflect behavior and coverage across the plugin.

Core Features & Use Cases

  • Diff-aware inventory: compute git diffs to focus on changed skills/agents and flag orphaned source files with inferred doc targets.
  • History enrichment: aggregate episodic memory, private journal, and MEMORY.md to add usage context and surface accuracy risks.
  • Doc write and update: create or update docs respecting auto-sync flags, preserve hand-written content, and update index/meta-docs.
  • Live probe verification: generate CLI probes, apply strict pre-dispatch safety gating, run doc-probe, and iterate on failures up to three rounds.
  • Self-update & reporting: refresh Source Map and Probe Config, emit summary metrics, and offer automated GitHub issues for unresolved gaps.

Quick Start

Run e2e doc sync --auto to scan changed skills, update documentation, and run live CLI probes.

Frequently Asked Questions about e2e-doc-sync

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

FAQPage Schema
How do I automatically sync documentation with code changes in e2e pipelines?

To sync documentation with e2e code changes, use diff-aware inventory to compute git diffs and update corresponding docs automatically. This detects documentation gaps by focusing on modified source files and updating only affected sections.

What is diff-aware documentation synchronization?

Diff-aware documentation synchronization computes git diffs to focus on changed skills and agents, flagging orphaned source files with inferred doc targets. It ensures docs accurately reflect behavior and coverage after code modifications.

How do I verify live CLI probes against updated e2e documentation?

To verify live CLI probes against updated e2e documentation, generate probes with strict pre-dispatch safety gating and run doc-probe iterations up to three rounds, iterating on failures to close verification gaps.

Can I preserve hand-written content during automated documentation updates?

Yes, you can preserve hand-written content during automated documentation updates. The process respects auto-sync flags while creating or updating docs, ensuring manual additions remain intact across sync operations.

Does e2e documentation sync work without external dependencies?

Yes, e2e documentation sync works without external dependencies. The skill handles diff base auto-detection, Phase 1–6 orchestration, and self-updating Source Map and Probe Config internally without requiring additional packages or components.

What happens to unresolved documentation gaps after probe verification fails?

When probe verification fails after three rounds, unresolved documentation gaps are reported via summary metrics. The skill offers automated GitHub issues to track these gaps for further manual resolution and maintenance.