@sisu-ai/skill-explain 0.2.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/LICENSE +6 -0
- package/README.md +34 -0
- package/SKILL.md +24 -0
- package/package.json +30 -0
- package/resources/explanation-template.md +21 -0
package/LICENSE
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# @sisu-ai/skill-explain
|
|
2
|
+
|
|
3
|
+
Explanation skill for code and architecture walkthroughs.
|
|
4
|
+
|
|
5
|
+
Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @sisu-ai/skill-explain
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Usage
|
|
12
|
+
|
|
13
|
+
Point the skills middleware directly at the installed package:
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
skillsMiddleware({
|
|
17
|
+
directories: ["node_modules/@sisu-ai/skill-explain"],
|
|
18
|
+
});
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Or copy the skill into your project skills directory:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
mkdir -p .sisu/skills/explain
|
|
25
|
+
cp -R node_modules/@sisu-ai/skill-explain/* .sisu/skills/explain/
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Resources
|
|
29
|
+
|
|
30
|
+
- `resources/explanation-template.md`
|
|
31
|
+
|
|
32
|
+
License
|
|
33
|
+
|
|
34
|
+
Apache-2.0
|
package/SKILL.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: explain
|
|
3
|
+
description: Explain code and architecture clearly for different audiences
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
author: sisu
|
|
6
|
+
tags: [explain, docs, onboarding]
|
|
7
|
+
requires: [read_file, grep]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Explain Code
|
|
11
|
+
|
|
12
|
+
Use this skill to explain modules, APIs, and architecture clearly.
|
|
13
|
+
|
|
14
|
+
## Steps
|
|
15
|
+
|
|
16
|
+
1. Identify the module and its responsibilities
|
|
17
|
+
2. Map key data flows and dependencies
|
|
18
|
+
3. Explain entry points and outputs
|
|
19
|
+
4. Provide examples or usage snippets
|
|
20
|
+
5. Tailor depth to the audience
|
|
21
|
+
|
|
22
|
+
## Resources
|
|
23
|
+
|
|
24
|
+
See `resources/explanation-template.md`.
|
package/package.json
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@sisu-ai/skill-explain",
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"files": [
|
|
7
|
+
"SKILL.md",
|
|
8
|
+
"resources"
|
|
9
|
+
],
|
|
10
|
+
"publishConfig": {
|
|
11
|
+
"access": "public"
|
|
12
|
+
},
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "https://github.com/finger-gun/sisu",
|
|
16
|
+
"directory": "packages/skills/skill-explain"
|
|
17
|
+
},
|
|
18
|
+
"homepage": "https://github.com/finger-gun/sisu#readme",
|
|
19
|
+
"bugs": {
|
|
20
|
+
"url": "https://github.com/finger-gun/sisu/issues"
|
|
21
|
+
},
|
|
22
|
+
"keywords": [
|
|
23
|
+
"sisu",
|
|
24
|
+
"ai",
|
|
25
|
+
"ai-agent",
|
|
26
|
+
"agentic",
|
|
27
|
+
"skill",
|
|
28
|
+
"explain"
|
|
29
|
+
]
|
|
30
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Explanation Template
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
What the module does and why it exists.
|
|
6
|
+
|
|
7
|
+
## Key Concepts
|
|
8
|
+
|
|
9
|
+
Important terms or abstractions.
|
|
10
|
+
|
|
11
|
+
## Data Flow
|
|
12
|
+
|
|
13
|
+
How inputs move through the module.
|
|
14
|
+
|
|
15
|
+
## Entry Points
|
|
16
|
+
|
|
17
|
+
Main functions/classes and their responsibilities.
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
Short usage snippet.
|