writing-docs
Installation
SKILL.md
Writing Medusa Documentation
Skill for writing and updating MDX documentation across the book, resources, ui, user-guide, and cloud projects under www/apps/.
Constraints
CRITICAL: Violating these will corrupt the documentation or break CI.
- Never document
@ignore-tagged items — any option, method, or parameter with@ignorein its TSDoc must be skipped entirely - Never touch
www/apps/resources/references/— auto-generated, will be overwritten - Never touch
www/apps/ui/specs/components/— auto-generated, will be overwritten - Never touch
www/apps/api-reference/— managed by a separate process - Never run
yarn preporyarn lint:content— these run automatically after your session - Never invent Cloudinary screenshot URLs in user-guide — leave
<!-- TODO: add screenshot -->instead
Load Reference Files When Needed
Load at least one reference file before writing any content.