writing-tsdocs
Installation
SKILL.md
Writing Medusa TSDocs
Adds TypeDoc (TSDoc) comments to Medusa TypeScript source files. Follows TypeDoc conventions and uses custom tags defined in www/utils/packages/typedoc-config/tsdoc.json.
Constraints
CRITICAL: Violating these produces incorrect or broken documentation.
- Never document unexported items — only
exported interfaces, types, functions, classes - Never add TSDocs to test files — skip
*.spec.ts,*.test.ts,__tests__/ - Never fabricate
@sinceversion numbers — only use the version passed in the prompt - Never remove or modify existing TSDocs — only add where missing
- Never modify logic — only add/edit comment blocks
- For Medusa-specific custom tags, only use those defined in
tsdoc.json:@expandable,@featureFlag,@since,@apiIgnore,@schema,@tags,@version,@keep,@customNamespace,@namespaceMember
Load Reference Files When Needed
Load the reference file for the file type you're documenting before writing any TSDocs.