API Reference Documentation Writer

What problem does it solve?

This Skill streamlines the creation and updating of API reference documentation for the Medusa ecommerce platform, ensuring consistency and accuracy.

Core Features & Use Cases

• MDX Content Generation: Creates or modifies markdown pages for API documentation, following established patterns.
• Component Usage: Leverages specific React components (docs-ui, layouts) for structured documentation.
• Code Example Integration: Includes multi-language code examples (JS SDK, cURL) for clarity.
• Vale Compliance: Enforces writing standards and style guides.
• Use Case: When a new API endpoint is added to Medusa, this Skill can be used to generate the corresponding documentation section in admin.mdx or store.mdx, including authentication details and example requests.

Quick Start

Use the API Reference Documentation Writer skill to add a new section on "Product Variants" to the store.mdx file, including JS SDK and cURL examples.