changeset-doc-sync

Sync documentation with active changesets across www and packages directories.

434|33|Updated Jul 27, 2025
One-click install
npx skills add https://github.com/udecode/kitcn --skill changeset-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changeset-doc-sync
Source: https://github.com/udecode/kitcn/tree/main/.agents/skills/changeset-doc-sync
Command: npx skills add https://github.com/udecode/kitcn --skill changeset-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Read every doc in www and packages/kitcn/skills/convex, sync to active changeset(s), and track with checkmarks.

Core Features & Use Cases

  • Automates alignment of documentation with the current changeset content to ensure release-readiness.
  • Enforces a structured workflow across documentation updates, review, and cross-file crosswalks.
  • Use Case: When preparing a new release, run this workflow to ensure every affected doc is updated and checked.

Quick Start

Run the changeset-doc-sync workflow to align docs with the current changesets.

Frequently Asked Questions about changeset-doc-sync

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

FAQPage Schema
How do I sync documentation with changesets before a release?

To sync documentation with changesets, you need a workflow that reads every affected doc, aligns content with the current changeset, and tracks updates with checkmarks. This ensures your release docs reflect the current codebase state.

What is the best way to keep docs in lockstep with changesets across multiple directories?

Keeping docs in lockstep with changesets across directories requires automating cross-repo and cross-dir alignment. The process enforces a mandatory sequence of preflight review, file-based planning, changeset integration, and crosswalk updates.

How do changeset crosswalk updates work for documentation?

Changeset crosswalk updates work by enforcing a structured workflow that reviews affected docs, applies file-based planning, integrates changeset content, and records progress and findings to track release-readiness across directories.

Can I use changeset-doc-sync for cross-repo documentation alignment?

Yes, changeset-doc-sync supports cross-repo and cross-dir alignment across www and packages. It applies to any project using changesets to track releases and requires documentation to reflect the current codebase state.

Does documentation sync work with changeset-based release management workflows?

Documentation sync works directly with changeset-based release management by automating the alignment of docs with active changesets. It enforces a mandatory sequence of preflight review, planning, integration, and crosswalk updates.

Why does my documentation drift out of sync with changesets during releases?

Documentation drifts out of sync with changesets when there is no enforced workflow for cross-file crosswalks and progress tracking. Automating changeset integration and file-based planning ensures docs stay aligned with the current codebase.