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.
주요 기능
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
사용 사례
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