Skills
.Work. You
Rest

sync-api-docs

Community

Keep API docs in lockstep with code.

Software Engineering#documentation#openapi#sdk#sync#docs#api-docs
Authornot-elm
Version1.0.0
Installs0

System Documentation

What problem does it solve?

API documentation often drifts from the actual server and SDK implementations as code evolves. This skill ensures OpenAPI and SDK manuals stay aligned with the current codebase, reducing drift and confusion for developers and integrators.

Core Features & Use Cases

  • Automated alignment: Compare server endpoints and SDK interfaces against docs and identify drift.
  • Change classification: Detect new, changed, unchanged, and removed items and report a clear summary.
  • Update workflow: Prompt for updates and apply changes to docs/api/open-api.yml and docs/mod-manual/src/sdk after confirmation.

Quick Start

Run the sync-api-docs skill to align OpenAPI and SDK documentation with the latest server and client code.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: sync-api-docs
Download link: https://github.com/not-elm/desktop-homunculus/archive/main.zip#sync-api-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.