Which specific files does this skill modify?

It is optimized for files within the www/apps/api-reference/markdown/ directory, such as admin.mdx, store.mdx, and client-libraries.mdx.

What terminology rules does the skill enforce?

It follows strict Vale compliance, ensuring the use of 'Workflows SDK', 'Commerce Module', 'Medusa Admin', and the correct spelling of 'ecommerce' without a hyphen.

Can it handle multi-language code examples?

Yes, it automatically generates tabbed code blocks (CodeTabs) for both the JavaScript SDK and cURL commands for every API section.

Does this skill generate OpenAPI specifications?

No, it focuses on hand-written MDX documentation for common patterns and authentication that complement auto-generated OpenAPI route documentation.

Medusa API Reference Writer

Name: Medusa API Reference Writer
Author: medusajs

bymedusajs

•

31,823

•

API Development

Generates and maintains professional API reference documentation for the Medusa commerce platform using standardized MDX patterns and React components.

The Medusa API Reference Writer is a specialized technical writing skill designed to maintain the extensive documentation ecosystem of the Medusa commerce platform. It automates the creation and update of hand-written MDX pages for the Admin and Store APIs, ensuring structural consistency across authentication guides, query parameter definitions, and multi-language code examples. By strictly adhering to Medusa's Vale compliance rules and leveraging specialized React layout components from the docs-ui package, this skill enables developers to produce production-grade documentation that integrates perfectly with the Medusa documentation site.

Key Features

01Ensures Vale compliance for terminology like 'Workflows SDK' and 'ecommerce'

02Generates synchronized code examples for both JavaScript SDK and cURL

03Structures complex API patterns including pagination, metadata, and field selection

0431,823 GitHub stars

05Manages cross-project link syntax for docs, resources, and UI components

06Automates Medusa-specific MDX layouts using DividedMarkdown components

Use Cases

01Creating localized Store API guides with specific IETF BCP 47 formatting requirements

02Updating the Medusa Admin API documentation with new authentication methods or headers

03Standardizing existing hand-written MDX files to match the latest docs-ui component patterns

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add medusajs/medusa api-ref-doc

For use in Claude.ai and ChatGPT

Download Skill