docs-automation

Official

Automatically keeps your docs in sync with code.

AuthorBasedHardware
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill keeps project documentation aligned with code changes by automatically updating API references, architecture diagrams, and developer guides across the docs stack.

Core Features & Use Cases

  • API Reference Generation: Detect changes in backend endpoints and generate or update API reference documentation.
  • Architecture Diagram Updates: Generate or refresh Mermaid/diagram diagrams when architecture shifts.
  • Docs Synchronization: Sync between internal (cursor) docs and external docs to ensure consistency.
  • Use Case: When a new FastAPI route is added, the skill updates docs/api-reference/endpoint and docs/doc/developer/api with a description and examples.

Quick Start

Run the docs automation to scan changed code and refresh API references and architecture diagrams.

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: docs-automation
Download link: https://github.com/BasedHardware/omi/archive/main.zip#docs-automation

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 223,000+ vetted skills library on demand.