API Reference Documentation Writer

Generate and update MDX API reference documentation for the Medusa platform.

35.7k|5.0k|Updated Jan 18, 2020
One-click install
npx skills add https://github.com/medusajs/medusa --skill api-reference-documentation-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: API Reference Documentation Writer
Source: https://github.com/medusajs/medusa/tree/main/.claude/skills/api-ref-doc
Command: npx skills add https://github.com/medusajs/medusa --skill api-reference-documentation-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about API Reference Documentation Writer

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

FAQPage Schema
How do I generate API reference documentation for Medusa ecommerce endpoints?

Generate Medusa API reference documentation by creating or modifying MDX files within the `www/apps/api-reference/markdown/` directory. This process writes structured markdown pages for Admin API, Store API, and client libraries, adhering to specific project patterns and Vale compliance rules.

How do I add multi-language code examples to Medusa API documentation?

Add multi-language code examples to Medusa API documentation by integrating JS SDK and cURL snippets directly into the MDX files. This approach uses specific `docs-ui` React components to render structured documentation and ensure clarity for API consumers.

What is the best way to write MDX files for Medusa Store API and Admin API endpoints?

The best way to write MDX files for Medusa APIs is to update the `admin.mdx` or `store.mdx` files using established project patterns. This ensures the generated API reference documentation includes correct authentication details, cross-project links, and example requests.

Does API documentation generation for Medusa enforce writing standards and style guides?

Yes, API documentation generation for Medusa enforces writing standards through Vale compliance rules. This ensures all generated MDX content meets specific style guide requirements, maintaining consistency and accuracy across the entire ecommerce platform API reference.

Can I use custom React components for structuring Medusa API reference markdown?

Yes, you can leverage specific React components, such as `docs-ui` and layouts, for structuring Medusa API reference markdown. This allows for organized MDX content generation that integrates seamlessly with the existing documentation infrastructure.