SuavePlan/skills
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Align sp skill traversal paths with relocated docs tree

Browse Source 
The Architecture index row and the four-tier traversal described
navigation via packages/ (genesis-monorepo naming). Point them at the
actual ${CLAUDE_PLUGIN_ROOT}/docs/ tree with relative child links,
keeping the accurate note that the tree mirrors the monorepo packages/.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
admin
2026-05-30 10:30:25 +01:00
parent 1d6dbf36f4
commit db1ce43ee1
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
plugins/document-navigator/skills/sp/SKILL.md
View File

@@ -12,7 +12,7 @@ Match natural-language intent to `@suaveplan/*` packages and extract working cod
| Layer | Source | | Layer | Source |
|-------|--------| |-------|--------|
| User intent | Natural language via `/sp` or direct invocation | | User intent | Natural language via `/sp` or direct invocation |
| Package index | `packages/README.md` → category READMEs → subcategory READMEs → package READMEs | | Package index | `${CLAUDE_PLUGIN_ROOT}/docs/README.md` → category READMEs → subcategory READMEs → package READMEs |
| Docs tree | `${CLAUDE_PLUGIN_ROOT}/docs/` (`.md`-only mirror of `packages/`, maintained externally) | | Docs tree | `${CLAUDE_PLUGIN_ROOT}/docs/` (`.md`-only mirror of `packages/`, maintained externally) |
| Examples | Linked `.md` files inside each package (`src/**/*.md`) | | Examples | Linked `.md` files inside each package (`src/**/*.md`) |
@@ -47,22 +47,22 @@ grep -ri "twilio" ${CLAUDE_PLUGIN_ROOT}/docs/
### Traversing the hierarchy ### Traversing the hierarchy
The documentation is a four-tier chain. Each tier summarizes its children and links to their READMEs: The documentation is a four-tier chain rooted at `${CLAUDE_PLUGIN_ROOT}/docs/`. Each tier summarizes its children and links to their READMEs (links inside the tree are relative, e.g. `./<category>/README.md`):
1. **Root index** — `packages/README.md` 1. **Root index** — `${CLAUDE_PLUGIN_ROOT}/docs/README.md`
- Lists every category with a one-line summary. - Lists every category with a one-line summary.
- Links to each `packages/<category>/README.md`. - Links to each `<category>/README.md`.
2. **Category index** — `packages/<category>/README.md` 2. **Category index** — `<category>/README.md`
- Lists every subcategory with a one-line summary. - Lists every subcategory with a one-line summary.
- Links to each `packages/<category>/<subcategory>/README.md`. - Links to each `<category>/<subcategory>/README.md`.
3. **Subcategory index** — `packages/<category>/<subcategory>/README.md` 3. **Subcategory index** — `<category>/<subcategory>/README.md`
- Contains a table of every package in that subcategory. - Contains a table of every package in that subcategory.
- Each row has the package name, a one-line description, and a link to `packages/<category>/<subcategory>/<pkg>/README.md`. - Each row has the package name, a one-line description, and a link to `<category>/<subcategory>/<pkg>/README.md`.
- Read this to identify candidate packages before drilling deeper. - Read this to identify candidate packages before drilling deeper.
4. **Package README** — `packages/<category>/<subcategory>/<pkg>/README.md` 4. **Package README** — `<category>/<subcategory>/<pkg>/README.md`
- Full description, install command (`bun add @suaveplan/<name>`), and quick-start code block. - Full description, install command (`bun add @suaveplan/<name>`), and quick-start code block.
- Contains a **documentation tree** that links to every module-level `.md` file inside `src/`. - Contains a **documentation tree** that links to every module-level `.md` file inside `src/`.
- Follow those links to find API usage patterns and typed examples. - Follow those links to find API usage patterns and typed examples.
@@ -73,7 +73,7 @@ Module `.md` files (e.g., `src/analysis/analysis-op.md`) contain API usage patte
## Constraints ## Constraints
- Only reference packages that exist nested within `packages/`. Do not invent package names. - Only reference packages that exist under `${CLAUDE_PLUGIN_ROOT}/docs/`. Do not invent package names.
- Use exact `@suaveplan/<name>` identifiers from `package.json`. - Use exact `@suaveplan/<name>` identifiers from `package.json`.
- Extract code examples verbatim from `.md` files; do not fabricate import paths. - Extract code examples verbatim from `.md` files; do not fabricate import paths.
- Assume the docs tree is current; do not concern yourself with how it is maintained. - Assume the docs tree is current; do not concern yourself with how it is maintained.