From 6e31de5847ddbad3e86c8baa3f54b7a7fb01fe76 Mon Sep 17 00:00:00 2001 From: nighty Date: Wed, 29 Apr 2026 11:15:36 +0800 Subject: [PATCH] docs: fix custom skill naming example Fix the custom skill docs example so the folder and SKILL.md frontmatter use the same hyphen-case name. --- docs/tools/creating-skills.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/tools/creating-skills.md b/docs/tools/creating-skills.md index 0b7e88baa4d..624c0e223f8 100644 --- a/docs/tools/creating-skills.md +++ b/docs/tools/creating-skills.md @@ -29,7 +29,7 @@ For how skills are loaded and prioritized, see [Skills](/tools/skills). ```markdown --- - name: hello_world + name: hello-world description: A simple skill that says hello. --- @@ -39,6 +39,9 @@ For how skills are loaded and prioritized, see [Skills](/tools/skills). "Hello from your custom skill!". ``` + Use hyphen-case with lowercase letters, digits, and hyphens for the skill + `name`. Keep the folder name and frontmatter `name` aligned. + @@ -83,13 +86,13 @@ For how skills are loaded and prioritized, see [Skills](/tools/skills). The YAML frontmatter supports these fields: -| Field | Required | Description | -| ----------------------------------- | -------- | ------------------------------------------- | -| `name` | Yes | Unique identifier (snake_case) | -| `description` | Yes | One-line description shown to the agent | -| `metadata.openclaw.os` | No | OS filter (`["darwin"]`, `["linux"]`, etc.) | -| `metadata.openclaw.requires.bins` | No | Required binaries on PATH | -| `metadata.openclaw.requires.config` | No | Required config keys | +| Field | Required | Description | +| ----------------------------------- | -------- | -------------------------------------------------------------- | +| `name` | Yes | Unique identifier using lowercase letters, digits, and hyphens | +| `description` | Yes | One-line description shown to the agent | +| `metadata.openclaw.os` | No | OS filter (`["darwin"]`, `["linux"]`, etc.) | +| `metadata.openclaw.requires.bins` | No | Required binaries on PATH | +| `metadata.openclaw.requires.config` | No | Required config keys | ## Best practices