docs-automation

Detect code changes and generate MDX API references and architecture diagrams.

13.1k|2.2k|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/BasedHardware/omi --skill docs-automation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-automation
Source: https://github.com/BasedHardware/omi/tree/main/.cursor/skills/docs-automation
Command: npx skills add https://github.com/BasedHardware/omi --skill docs-automation

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about docs-automation

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

FAQPage Schema
How do I automatically update FastAPI documentation when code changes?

To automatically update FastAPI documentation when code changes, you need a tool that monitors backend routers and data models to detect modifications. This skill scans changed code and refreshes API references and architecture diagrams accordingly, ensuring your docs stay in sync with your backend endpoints.

What is the best way to keep architecture diagrams in sync with code?

The best way to keep architecture diagrams in sync with code is to automate the generation and refresh process using Mermaid. This skill detects architectural shifts in your codebase and automatically updates your Mermaid diagrams, eliminating the need for manual diagram edits when your system structure changes.

Can I sync internal and external developer docs automatically?

Yes, you can sync internal and external developer docs automatically. This skill synchronizes documentation between internal cursor docs and external docs locations, ensuring consistency across your entire documentation stack without requiring manual copy-pasting between directories.

Does this documentation automation tool generate MDX files for API references?

Yes, this documentation automation tool generates MDX files for API references. When it detects changes in backend endpoints, it automatically generates or updates MDX and API reference files across multiple documentation locations with descriptions and examples.

When do I need to automate API reference generation?

You need to automate API reference generation when your project frequently adds or modifies backend endpoints and data models. Automating this process prevents documentation drift, ensuring that developer guides and API references accurately reflect the current state of your codebase.