API Reference Documentation Writer

Community

Write API docs for Medusa

AuthorAnikAKB
Version1.0.0
Installs0

System Documentation

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 across Admin API, Store API, and client libraries.

Core Features & Use Cases

  • Automated Documentation Generation: Leverages OpenAPI specs to auto-generate route documentation.
  • Manual Content Creation: Supports hand-written MDX for common patterns, authentication, and custom explanations.
  • Component-Based Structure: Utilizes React components for a consistent and maintainable documentation structure.
  • Multi-language Examples: Integrates JS SDK and cURL examples for comprehensive API usage.
  • Use Case: Update the authentication section for the Store API by adding details about the Publishable API Key and providing new JS SDK and cURL examples.

Quick Start

Ask the API Reference Documentation Writer to add a new section on "Pagination" to the store.mdx file.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: API Reference Documentation Writer
Download link: https://github.com/AnikAKB/dps/archive/main.zip#api-reference-documentation-writer

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.