@iamdangavin/claude-skill-vitepress-docs 1.0.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/package.json +5 -2
- package/skill/SKILL.md +19 -15
package/README.md
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iamdangavin/claude-skill-vitepress-docs",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "Installs the vitepress:docs Claude Code skill — VitePress docs setup, generation, screenshots, and sync.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -17,5 +17,8 @@
|
|
|
17
17
|
"vitepress",
|
|
18
18
|
"docs"
|
|
19
19
|
],
|
|
20
|
-
"license": "MIT"
|
|
20
|
+
"license": "MIT",
|
|
21
|
+
"publishConfig": {
|
|
22
|
+
"access": "public"
|
|
23
|
+
}
|
|
21
24
|
}
|
package/skill/SKILL.md
CHANGED
|
@@ -337,9 +337,11 @@ If the user corrects you, accept their answer and proceed with the corrected sta
|
|
|
337
337
|
- "Astro"
|
|
338
338
|
- "Other — I'll tell you"
|
|
339
339
|
|
|
340
|
-
**WP-Q6 — Theme / plugin folder** (plain text): Scan `wp-content/themes/` and `wp-content/plugins/` for likely candidates first — present your best guess and let the user confirm or correct it. Ask — "Which theme or plugin should I focus on? (e.g. `wp-content/themes/my-theme
|
|
340
|
+
**WP-Q6 — Theme / plugin folder(s)** (plain text): Scan `wp-content/themes/` and `wp-content/plugins/` for likely candidates first — present your best guess and let the user confirm or correct it. Ask — "Which theme or plugin should I focus on? You can provide multiple paths if they work together. (e.g. `wp-content/themes/my-theme, wp-content/plugins/my-plugin`)"
|
|
341
341
|
|
|
342
|
-
Once WP-Q6 is answered, the
|
|
342
|
+
Once WP-Q6 is answered, the confirmed paths become the **focus paths**. All subsequent analysis, docs placement, and git root detection are scoped to these paths — the WP install root is off-limits.
|
|
343
|
+
|
|
344
|
+
**Each focus path must be its own git repository.** Git root detection (below) will validate this for every path provided. If any path is missing a `.git`, halt and ask the user to resolve it before continuing — do not proceed with a partial set.
|
|
343
345
|
|
|
344
346
|
Store all WP answers and carry them through the rest of generate mode. They affect codebase analysis (Step 2) and the doc structure proposal (Step 3).
|
|
345
347
|
|
|
@@ -347,10 +349,10 @@ Store all WP answers and carry them through the rest of generate mode. They affe
|
|
|
347
349
|
|
|
348
350
|
#### Git root detection (all stacks)
|
|
349
351
|
|
|
350
|
-
**For WordPress:** run this check against
|
|
352
|
+
**For WordPress:** run this check against every path confirmed in WP-Q6.
|
|
351
353
|
**For all other stacks:** run this check against the detected codebase root (current working directory unless corrected above).
|
|
352
354
|
|
|
353
|
-
|
|
355
|
+
For each focus path, check for a `.git` directory at **that exact path**:
|
|
354
356
|
|
|
355
357
|
```bash
|
|
356
358
|
ls FOCUS_PATH/.git
|
|
@@ -358,20 +360,14 @@ ls FOCUS_PATH/.git
|
|
|
358
360
|
|
|
359
361
|
Do not check parent folders — the `.git` must be in the specific folder being documented. For WordPress this means checking inside `wp-content/themes/my-theme/` or `wp-content/plugins/my-plugin/`, not in `wp-content/themes/`, `wp-content/`, or the WP install root.
|
|
360
362
|
|
|
361
|
-
**If `.git` is found
|
|
362
|
-
|
|
363
|
-
**If `.git` is not found:** ask:
|
|
363
|
+
**If `.git` is found:** no question needed — the repo root and focus path are the same. Proceed.
|
|
364
364
|
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
- options:
|
|
368
|
-
- "It's at the WP install root (the folder I was invoked from)"
|
|
369
|
-
- "It's somewhere else — I'll tell you the path"
|
|
370
|
-
- "There's no git repo yet"
|
|
365
|
+
**If `.git` is not found:** halt and tell the user:
|
|
366
|
+
> "I didn't find a `.git` folder at [FOCUS_PATH]. Each documented path must be its own git repository. Please initialise a repo there and come back, or remove this path from the list."
|
|
371
367
|
|
|
372
|
-
|
|
368
|
+
Do not continue until every focus path has a confirmed `.git`. Each path gets its own independent docs output, manifest, and GitHub Actions workflow.
|
|
373
369
|
|
|
374
|
-
This matters because the GitHub Actions workflow file must go in `.github/workflows/` at the **git root
|
|
370
|
+
This matters because the GitHub Actions workflow file must go in `.github/workflows/` at the **git root** of each respective path.
|
|
375
371
|
|
|
376
372
|
---
|
|
377
373
|
|
|
@@ -404,6 +400,14 @@ Wait for all answers.
|
|
|
404
400
|
|
|
405
401
|
### Step 2 — Analyze the codebase
|
|
406
402
|
|
|
403
|
+
#### Scope rule
|
|
404
|
+
|
|
405
|
+
**Single focus path:** analysis is strictly confined to that directory. Do not read, Glob, or Grep anywhere outside it — including the WP install root, other themes, other plugins, or WP core.
|
|
406
|
+
|
|
407
|
+
**Multiple focus paths:** analysis is confined to the declared paths combined. Cross-reading between them is allowed and expected — if the theme references a function from the plugin, follow that reference. Nothing outside the declared set is fair game.
|
|
408
|
+
|
|
409
|
+
In both cases: if a file inside a focus path imports or references something outside the declared paths, read only that specific referenced file — do not expand analysis to its parent directory.
|
|
410
|
+
|
|
407
411
|
Scan the codebase systematically. Build a mental map before writing anything. Look for:
|
|
408
412
|
|
|
409
413
|
**For user-facing docs:**
|