Skip to content
Prompt

medusa — Cursor Rules

by medusajs

AI Summary

This file defines the structure and formatting requirements for creating Medusa tutorials in the directory. All tutorials must follow this structure to ensure consistency and quality. Every tutorial must start with YAML frontmatter containing: After frontmatter, include necessary imports:

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to add the "medusa — Cursor Rules" prompt rules to my project.
Repository: https://github.com/medusajs/medusa

Please read the repo to find the rules/prompt file, then:
1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type)
2. If there's an existing rules file, merge the new rules in rather than overwriting
3. Confirm what was added

Description

The world's most flexible commerce platform.

Overview

This file defines the structure and formatting requirements for creating Medusa tutorials in the /app/how-to-tutorials/tutorials/ directory. All tutorials must follow this structure to ensure consistency and quality.

1. Frontmatter (Required)

Every tutorial must start with YAML frontmatter containing: `yaml --- sidebar_label: "Tutorial Name" # Display name in sidebar tags: • name: product_name # Product tags (e.g., cart, order, customer) label: "Implement Feature" • server # Always include if server-side code • tutorial # Always include • nextjs # Include if storefront customization products: • product_name # Array of product names used --- ` Additional frontmatter options: • keywords: Array of keywords for SEO (optional) • ogImage: Export for Open Graph image (optional)

2. Imports

After frontmatter, include necessary imports: • Github, PlaySolid from @medusajs/icons (if needed) • Prerequisites, WorkflowDiagram, CardList, Card from docs-ui • Other necessary components

3. Metadata Export

`typescript export const metadata = { title: Implement Feature Name in Medusa, // Optional: openGraph and twitter metadata } `

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted Today
Active
Adoption1K+ stars on GitHub
34.5k ★ · Popular
DocsMissing or thin
Undocumented

GitHub Signals

Stars34.5k
Forks4.7k
Issues104
UpdatedToday
View on GitHub
MIT License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Any AI assistant that accepts custom rules or system prompts

Claude
ChatGPT
Cursor
Windsurf
Copilot
+ more