add YAML frontmatter requirement to SKILL.md and guide.md
This commit is contained in:
@@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
name: claw-skills
|
||||||
|
description: ClawSkills management and collaboration suite — scripts and workflows for using and improving skills.
|
||||||
|
---
|
||||||
|
|
||||||
# claw-skills
|
# claw-skills
|
||||||
|
|
||||||
ClawSkills management and collaboration suite — scripts and workflows for using and improving skills.
|
ClawSkills management and collaboration suite — scripts and workflows for using and improving skills.
|
||||||
|
|||||||
@@ -13,7 +13,16 @@ A skill is a directory with the following layout:
|
|||||||
|
|
||||||
## Writing Requirements
|
## Writing Requirements
|
||||||
|
|
||||||
**SKILL.md should be concise.** It serves as a table of contents for workflows — list each workflow file path with the scenario that triggers it.
|
**SKILL.md must start with a YAML frontmatter block:**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
name: {skill-name}
|
||||||
|
description: {when-to-use}
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
**SKILL.md body should be concise.** It serves as a table of contents for workflows — list each workflow file path with the scenario that triggers it. For supplementary documentation, use `docs/`.
|
||||||
|
|
||||||
> **All skill-related documentation must be written in English.**
|
> **All skill-related documentation must be written in English.**
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user