update-api-docs

Audits and updates API documentation from route definitions and handler files.

1.8k|249|Updated Aug 3, 2023
One-click install
npx skills add https://github.com/robustmq/robustmq --skill update-api-docs-robustmq
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-api-docs
Source: https://github.com/robustmq/robustmq/tree/main/.claude/skills/update-api-docs
Command: npx skills add https://github.com/robustmq/robustmq --skill update-api-docs-robustmq

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Ensures API documentation remains accurate and up-to-date with the actual route definitions in the codebase, reducing errors and confusion.

Core Features & Use Cases

  • Route Definition Matching: Compares and updates API documentation with actual route definitions.
  • Language Syncing: Synchronizes English and Chinese documentation to maintain consistency.
  • Use Case: Streamline the process of maintaining API documentation by automating the audit and update process.

Quick Start

Run the update-api-docs skill to audit and update API documentation.

Frequently Asked Questions about update-api-docs

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

FAQPage Schema
How do I automate API documentation updates to match my codebase route definitions?

You can automate API documentation updates by auditing route definitions in path.rs and synchronizing handler request/response data with your documentation. This ensures your API documentation accurately reflects the actual codebase routes.

What is the best way to keep English and Chinese API documentation synchronized?

To keep English and Chinese API documentation synchronized, use an automated language syncing feature that compares both versions against actual codebase routes. This maintains consistency between both language sets during route definition updates.

What files do I need to audit API documentation against codebase routes?

Auditing API documentation against codebase routes requires path.rs for route definitions and handler files for request/response data. These files provide the necessary route matching and payload information to update the documentation accurately.

How does route definition matching work for API maintenance?

Route definition matching for API maintenance works by comparing existing API documentation directly against actual codebase route definitions. It identifies discrepancies and updates the documentation to align with the implemented routes and handler payloads.

Why is my API documentation out of sync with my codebase routes?

API documentation falls out of sync with codebase routes when route definitions are updated manually without automating the documentation audit process. Running an automated documentation update skill reconciles these differences by matching routes in path.rs.