writing-tutorials

Builds Medusa tutorial features in example projects, then writes MDX documentation.

36.1k|5.2k|Updated Jan 18, 2020
One-click install
npx skills add https://github.com/medusajs/medusa --skill writing-tutorials
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-tutorials
Source: https://github.com/medusajs/medusa/tree/main/.claude/skills/writing-tutorials
Command: npx skills add https://github.com/medusajs/medusa --skill writing-tutorials

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Creating Medusa documentation tutorials requires both a working code example and polished MDX documentation, and doing both at once often produces untested code samples or inconsistent docs. This Skill enforces a two-phase workflow that builds and tests the feature first, then writes the documentation.

Core Features & Use Cases

  • Two-Phase Workflow: Phase 1 gathers requirements, plans, implements, and tests the tutorial feature in an example Medusa project; Phase 2 writes per-step MD files, combines them into a final MDX page, and updates the sidebar.
  • Documentation Conventions: Provides pre-written templates for the installation step, frontmatter, summary sections, CardList components, WorkflowDiagram usage, code block attributes, and verbatim concept definitions (module, workflow, API route, module providers, and more).
  • Use Case: When asked to create a how-to tutorial like "product reviews" or an integration guide like "PayPal payment provider", the Skill first builds and tests the feature in a Medusa app, then produces a complete page.mdx with sidebar registration in the Medusa docs site.

Quick Start

Ask the agent to create a new Medusa how-to tutorial for a feature such as product reviews, providing the tutorial type and the path to your example Medusa project.

Frequently Asked Questions about writing-tutorials

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

FAQPage Schema
How do I create a Medusa how-to tutorial for the docs site?

Follow the two-phase workflow: first build and test the feature in an example Medusa project with user-approved planning, then write per-step MD files, combine them into a page.mdx under how-to-tutorials/tutorials, and update the sidebar file.

How do I write a Medusa integration guide for a third-party service?

Build the integration as a module provider (notification, payment, fulfillment, analytics, or auth) in an example project first, then write the guide using the generic module provider intro plus the provider-specific concept definition, and place the MDX under integrations/guides.

Can I build the feature and write the documentation in one session?

No. The Skill explicitly forbids combining both phases in one session. Complete the build phase, get explicit user confirmation that the feature works, then reload the Skill to start the writing phase.

What MDX components are available for Medusa tutorials?

Available components include Prerequisites for Step 1 requirements, WorkflowDiagram for visualizing workflow steps, Note for tips and definitions, and CardList for linking the GitHub example repository and OpenAPI specs.

Why should tutorial code be kept simple?

Tutorial code is educational rather than production-grade, so the Skill instructs avoiding unnecessary abstractions, overly generic utilities, and complex patterns. One clear approach is preferred over multiple flexible ones so readers can follow along easily.