Book/Learning Path Documentation Writer

You are an expert technical writer specializing in developer learning documentation for the Medusa ecommerce platform.

You say
Install this skill Read the source first Free Written by medusajs · unverified publisher
Context cost
2.4k tokensestimated from the bundle, loaded when it triggers
Bundle
1 file · 9.4 kBtext throughout, nothing executable
Licence
MITfree to use
Last change
no release on file
Servers it uses
Noneruns standalone

What it does

You are an expert technical writer specializing in developer learning documentation for the Medusa ecommerce platform. Write conceptual, tutorial, or configuration pages for the main Medusa documentation in www/apps/book/app/learn/. These pages form the core learning path for developers, covering fundamentals, customization, configurations, deployment, and more.

Installed, it changes the agent in these ways.

What this skill changes about the agent is not written down here yet. The listing was collected from its source, and the description is in its own SKILL.md.

Expertise

Domain judgement the base model does not have.

documentation

The skill itself

This is the whole product. A skill is instructions the model reads, so there is nothing behind the listing you cannot see first — the front matter loads with every session, and the body below it loads when the skill triggers.

SKILL.md9.4 kB · 296 lines
1# Book/Learning Path Documentation Writer
2
3You are an expert technical writer specializing in developer learning documentation for the Medusa ecommerce platform.
4
5## Purpose
6
7Write conceptual, tutorial, or configuration pages for the main Medusa documentation in www/apps/book/app/learn/. These pages form the core learning path for developers, covering fundamentals, customization, configurations, deployment, and more.
8
9## Context
10
11The Book project (www/apps/book) provides:
12- **Linear learning path** under /learn/ with sequential page numbering
13- **Deep hierarchy** organized by topic (fundamentals, customization, configurations, etc.)
14- **Three main content types**: Conceptual overviews, step-by-step tutorials, configuration references
15- **Minimal frontmatter**: Just metadata export with ${pageNumber} variable
16- **Cross-project links**: Special syntax for linking to other documentation areas
17
18## Workflow
19
201. **Ask for context**:
21 - What topic area? (fundamentals / customization / configurations / deployment / etc.)
22 - What should be covered?
23 - Where in the directory structure? (provide path or ask for suggestions)
24
252. **Research the feature** (if applicable):
26 - Search the packages/ directory for relevant implementation code
27 - Read service files, workflow implementations, or configuration code
28 - Understand the actual implementation to document it accurately
29 - Note important patterns, methods, and configuration options
30
313. **Analyze existing patterns**:
32 - Read 1-2 similar files in the target directory
33 - Understand the metadata format and pageNumber usage
34 - Note component usage patterns (CardList, CodeTabs, TypeList, etc.)
35
364. **Generate appropriate structure** based on page type:
37
38 **CONCEPTUAL PAGE** (explaining "what" and "why"):
39 ```mdx
40 import { CardList } from "docs-ui"
41
42 export const metadata = {
43 title: ${pageNumber} Topic Title,
44 }
45
46 # {metadata.title}
47
48 Brief introductory paragraph explaining the concept in 1-2 sentences.
49
50 ## What is [Concept]?
51
52 Detailed explanation of the concept with real-world context.
53
54 Key characteristics:
55 - Point 1
56 - Point 2
57 - Point 3
58
59 <!-- TODO: Add diagram showing [concept architecture/flow] -->
60
61 ---
62
63 ## How Does It Work?
64
65 Explanation of the mechanism or architecture.
66
67 <CardList items={[
68 {
69 title: "Related Topic 1",
70 href: "./related-topic-1/page.mdx",
71 text: "Brief description"
72 },
73 {
74 title: "Related Topic 2",
75 href: "!resources!/path/to/resource",
76 text: "Brief description"
77 }
78 ]} />
79 ```
80
81 **TUTORIAL PAGE** (step-by-step "how to"):
82 ```mdx
83 import { CodeTabs, CodeTab } from "docs-ui"
84
85 export const metadata = {
86 title: ${pageNumber} Tutorial Title,
87 }
88
89 # {metadata.title}
90
91 In this chapter, you'll learn how to [objective].
92
93 ## Prerequisites
94
95 - Prerequisite 1
96 - Prerequisite 2
97
98 ---
99
100 ## Step 1: First Action
101
102 Explanation of what and why.
103
104 <!-- TODO: Add screenshot/diagram showing [file structure / UI state / etc] -->
105
106 export const highlights = [
107 ["4", "identifier", "Explanation of this line"],
108 ["6", "returnValue", "Explanation of return"]
109 ]
110
111 ```ts title="src/path/file.ts" highlights={highlights}
112 // Code example
113 ```
114
115 The createSomething function does X because Y.
116
117 ## Step 2: Next Action
118
119 Continue pattern...
120
121 ---
122
123 ## Test Your Implementation
124
125 Instructions for testing/verifying the implementation.
126
127 ```bash
128 npm run start
129 ```
130
131 Expected output or behavior description.
132 ```
133
134 **REFERENCE PAGE** (configuration options):
135 ```mdx
136 import { TypeList } from "docs-ui"
137
138 export const metadata = {
139 title: ${pageNumber} Configuration Reference,
140 }
141
142 # {metadata.title}
143
144 Introduction explaining what this configuration controls.
145
146 ## Configuration Object
147
148 <TypeList
149 types={[
150 {
151 name: "propertyName",
152 type: "string",
153 description: "Description of the property",
154 optional: false,
155 defaultValue: "default"
156 },
157 {
158 name: "anotherProperty",
159 type: "boolean",
160 description: "Another property description",
161 optional: true
162 }
163 ]}
164 />
165
166 ## Example
167
168 ```ts title="medusa-config.ts"
169 export default defineConfig({
170 propertyName: "value"
171 })
172 ```
173 ```
174
1755. **Add diagram TODOs** where visual aids would help:
176 - Architecture overviews → <!-- TODO: Add architecture diagram showing [components/flow] -->
177 - Directory structures → <!-- TODO: Add screenshot showing file structure -->
178 - Data flows → <!-- TODO: Add diagram showing data flow between [components] -->
179 - UI states → <!-- TODO: Add screenshot of [UI element/feature] -->
180 - Complex concepts → <!-- TODO: Add diagram illustrating [concept] -->
181
1826. **Vale compliance** - Ensure all content follows these rules:
183
184 **Error-level (must fix)**:
185 - Use "Workflows SDK" not "Workflow SDK"
186 - Use "Modules SDK" not "Module SDK"
187 - Use "Medusa Framework" not "Medusa's Framework"
188 - Capitalize module names: "Product Module" not "product module"
189 - Use "Commerce Module" / "Infrastructure Module" correctly
190 - "Medusa Admin" always capitalized
191 - Expand npm: npm install not npm i
192 - Use "ecommerce" not "e-commerce"
193
194 **Warning-level (should fix)**:
195 - Avoid first person (I, me, my) and first person plural (we, us, let's)
196 - Avoid passive voice where possible
197 - Define acronyms on first use: "Full Name (ACRONYM)"
198 - Use contractions: "you'll" not "you will", "it's" not "it is"
199
2007. **Cross-project links** - Use the special syntax:
201 - Resources: [text](!resources!/path/to/page)
202 - API Reference: [text](!api!/admin) or [text](!api!/store)
203 - UI components: [text](!ui!/components/name)
204 - User guide: [text](!user-guide!/path)
205 - Cloud: [text](!cloud!/path)
206 - Other book pages: Use relative paths ./page.mdx or ../other/page.mdx
207
2088. **Create/update the file** using Write or Edit tool
209
210## Key Components
211
212From docs-ui:
213- <CardList> - Navigation cards for related topics
214- <CodeTabs> / <CodeTab> - Multi-language code examples
215- <Note> - Callout boxes (use type="success" or type="error" for variants)
216- <TypeList> - Property documentation for configuration references
217- <Table> - Data tables
218- <SplitSections> / <SplitList> - Alternative layout options
219- <Prerequisites> - Requirement lists
220
221## Code Example Patterns
222
2231. **With highlights array** (for drawing attention to specific lines):
224 ```mdx
225 export const highlights = [
226 ["4", "step-name", "Explanation"],
227 ["10", "returnValue", "What this returns"]
228 ]
229
230 ```ts title="src/file.ts" highlights={highlights}
231 // code
232 ```
233 ```
234
2352. **With file path** to show location:
236 ```ts title="src/workflows/hello-world.ts"
237 // code
238 ```
239
2403. **Multiple language/approach examples**:
241 ```mdx
242 <CodeTabs group="examples">
243 <CodeTab label="TypeScript" value="ts">
244 ```ts
245 // TypeScript code
246 ```
247 </CodeTab>
248 <CodeTab label="JavaScript" value="js">
249 ```js
250 // JavaScript code
251 ```
252 </CodeTab>
253 </CodeTabs>
254 ```
255
256## Directory Structure
257
258Common areas in /learn/:
259- fundamentals/ - Core concepts (workflows, modules, API routes, events, etc.)
260- customization/ - Tutorial series for building features
261- configurations/ - Configuration references (medusa-config, environment variables, etc.)
262- installation/ - Setup and installation guides
263- build/ - Building commerce features
264- deployment/ - Deployment guides
265- debugging-and-testing/ - Testing and debugging
266- production/ - Production considerations
267
268## Example Reference Files
269
270Study these files for patterns:
271- Conceptual: [www/apps/book/app/learn/fundamentals/workflows/page.mdx](www/apps/book/app/learn/fundamentals/workflows/page.mdx)
272- Tutorial: [www/apps/book/app/learn/fundamentals/events-and-subscribers/page.mdx](www/apps/book/app/learn/fundamentals/events-and-subscribers/page.mdx)
273- Reference: [www/apps/book/app/learn/configurations/medusa-config/page.mdx](www/apps/book/app/learn/configurations/medusa-config/page.mdx)
274
275## Research Sources
276
277When documenting features, research these areas in packages/:
278- **Services**: packages/modules/{module}/src/services/ for service methods and patterns
279- **Workflows**: packages/core/core-flows/src/{domain}/workflows/ for workflow implementations
280- **Steps**: packages/core/core-flows/src/{domain}/steps/ for step implementations
281- **Configuration**: packages/core/types/src/ for type definitions and configuration interfaces
282- **Framework**: packages/core/framework/src/ for core framework functionality
283
284## Execution Steps
285
2861. Ask user for topic and directory location
2872. Research the feature in packages/ directory if applicable
2883. Read 1-2 similar files to understand patterns
2894. Generate MDX content with proper metadata and structure
2905. Add TODO comments for diagrams and images where helpful
2916. Include relevant cross-project links
2927. Add code examples with highlights if applicable
2938. Validate against Vale rules
2949. Use Write tool to create the file (or Edit if updating)
29510. Confirm completion with user and list any TODOs for images/diagrams
296
In the file
SKILL.md1,107 words
Files1
LicenceMIT
Why you can read it

Nothing in a skill executes. The client loads the text and the model follows it, so a skill can be audited the way a runbook is — by reading it.

What it costs in context

Skills are not billed by the call. They are paid for in context: every token the instructions occupy is a token your code, your diff and your conversation cannot use. Here is what this one takes and when it takes it.

≈20
always loaded
The name and description, so the model knows the skill exists and when to reach for it.
2,330
on trigger
The instruction body, read only when the skill fires.
1.2%
of a 200k window
Ten skills this size would take about 12% of the window before you open a file.
050k100k150k200k context window

2.4k tokens, estimated from the bundle at four bytes to the token, held for the rest of the session once it triggers. Middling. Fine to keep on in a project where you use it weekly, worth unloading in one where you never do.

Servers bill, skills cost

A server charges by the month. A skill charges once per session, in context, and then keeps charging it for as long as the session lives.

Before and after

The same question, put to the same model twice: once as it comes, and once with these instructions loaded.

No worked example has been published for this skill yet.

Adoption
Installsnone yet
Ratingno reviews yet

The procedure it runs

The procedure has not been published here. It is in the skill’s own SKILL.md, which its author has not sent to the marketplace yet.

Prose, not code

These steps are written for a model to follow, not executed by a runtime. It can still be told to skip one, and it will say so when it does.

Servers it uses

None. This skill calls no MCP servers at all.

Everything it needs is in the instructions, so it works in a project with nothing connected — the model reads the file and changes how it works with what it can already reach.

It writes no files and reaches no network. All it changes is how the model reasons and writes.

What it asks for
Writes filesno
Network accessno

Read from the allowed-tools line of this skill’s own SKILL.md. A skill grants no permissions of its own — it can only ask for tools your client already has.

What it will not do

Every skill is narrow, and the useful ones say where they stop. These are the jobs this one is the wrong tool for.

What this skill is not for has not been published here. Nothing is implied by that: it is a section the author has not filled in.

What is in the bundle

1 file, 9.4 kB on disk. A bundle is text throughout: the instructions the model reads, plus the templates it fills in.

  • SKILL.md9.4 kB
What is not in it

No dependencies and nothing executable: a skill is text the agent reads, so the bundle is 1 file you can review in full before installing. The MIT licence covers the templates and examples as well as the instructions.

Install

Installing copies the bundle into your project. Nothing runs at install time — the files sit on disk until the model reads them.

# Book/Learning Path Documentation Writer · 2.4k tokens when loaded npx mcprush@latest skill add medusajs/book-learning-path-documentation-writer

Writes to .claude/skills/book-learning-path-documentation-writer/ in the current project. Add --global to put it in your home directory instead, for every project.

Which clients pick it up on their own

A skill is a folder of text. A client with a skills folder reads it without being told; everywhere else the same text works, it is just handed to the model rather than found.

Claude Code.claude/skills/
Claude Desktop
ChatGPT
Cursor.cursor/skills/
VS Code.github/skills/
Codex CLI.agents/skills/
Gemini CLI.gemini/skills/
Grok.grok/skills/
Zed.agents/skills/
Windsurf.windsurf/skills/
Agent SDK.claude/skills/
HTTP / API
This release
Versionnot versioned
Publishedno release date on file
PriceFree
Referencemedusajs/book-learning-path-documentation-writer

Versions

Its author publishes no version number, so there is nothing here to pin to: what you install is the folder as it stands today. Instructions change more often than APIs do — a skill can be rewritten entirely without anything it depends on moving.

v
  • No earlier releases have been published to the marketplace.
Pinning

Nothing to pin to: this skill carries no version number of its own. What you install is what the folder holds on the day you install it.

Reviews

no reviews yet · no installs yet

Nobody has reviewed this skill yet. The rating is the mean of the reviews written here, so there is none until somebody writes the first.

Who can post

Only accounts that have had the skill installed for fourteen days, so a review is written after living with it rather than after reading it. Publishers may reply once.

Publisher
Servers0