meow:documentation

Sync code changes to living docs, API docs, and changelogs.

14|2|Updated Mar 25, 2026
One-click install
npx skills add https://github.com/ngocsangyem/MeowKit --skill meow-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: meow:documentation
Source: https://github.com/ngocsangyem/MeowKit/tree/main/.claude/skills/meow%3Adocumentation
Command: npx skills add https://github.com/ngocsangyem/MeowKit --skill meow-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation often drifts after code changes, slowing onboarding and API adoption. This skill provides a structured workflow to keep living docs, changelogs, and API documentation synchronized with the codebase.

Core Features & Use Cases

  • Living-docs synchronization: updates living documentation to reflect recent changes without rewriting existing content.
  • Changelog generation integration: generates and appends changelog entries from conventional commits.
  • API-docs alignment: aligns API reference docs with current endpoint implementations.

Quick Start

Run the living documentation workflow to update affected docs after code changes.

Frequently Asked Questions about meow:documentation

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

FAQPage Schema
How do I keep API documentation in sync with code changes?

To keep API documentation in sync with code changes, you can automate living-documentation updates that validate diffs before applying changes. This updates API reference docs to match current endpoint implementations while preserving unchanged content.

How do I generate a changelog from conventional commits?

You can generate a changelog from conventional commits by running a changelog generation integration that appends entries from your commit history. This automates changelog updates alongside your living docs during codebase changes.

What is living documentation and how does it stay updated?

Living documentation is a dynamic docs system that stays updated by syncing directly with code changes. It automatically applies updates to reflect recent modifications without rewriting existing content, preventing manual documentation drift.

Does this documentation automation preserve my existing markdown content?

Yes, this documentation automation preserves your existing markdown content by validating diffs before applying changes. It loads authoritative sources like living-docs.md and api-sync.md, only updating sections affected by recent code modifications.

Can I update living docs without rewriting the entire document?

Yes, you can update living docs without rewriting the entire document by applying diff-aware synchronization. This method targets only the sections impacted by recent code changes, leaving all unchanged content perfectly intact.

When should I run the living documentation workflow?

You should run the living documentation workflow during the Phase 6 Reflect stage or for explicit doc requests after code changes. This ensures API docs, changelogs, and living docs accurately reflect the current codebase state.