docs(skills): update SKILL.md format documentation to match implementation#54
Open
Ceheps wants to merge 1 commit intoshareAI-lab:mainfrom
Open
docs(skills): update SKILL.md format documentation to match implementation#54Ceheps wants to merge 1 commit intoshareAI-lab:mainfrom
Ceheps wants to merge 1 commit intoshareAI-lab:mainfrom
Conversation
…plementation - Replace HTML comment format with YAML frontmatter in examples - Remove metadata.json from directory structure (not implemented) - Add field reference table for required fields (name, description) - Add note about name field behavior differences between managers - Fix both en and zh-CN guides Fixes shareAI-lab#52
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix Skills guide documentation to match actual SDK implementation. Updates both English and Chinese versions of
docs/*/guides/skills.md.Changes:
<!-- skill: ... -->) with YAML frontmatter (---\nname: ...\ndescription: ...\n---) in SKILL.md examplesmetadata.jsonfrom directory structure (code never reads this file)name,description)namefield behavior differences betweenSkillsManager(uses folder name) andSkillsManagementManager(requires frontmattername)Closes #52
Motivation / Context
The current documentation describes SKILL.md format as HTML comments and lists
metadata.jsonas optional metadata. However, actual code implementation requires YAML frontmatter and never readsmetadata.json. This discrepancy causes confusion for developers following the documentation, resulting in skills being silently skipped during loading.Type of Change
Scope / Modules
Public API
src/index.tsBreaking Changes
Testing
npm run test:unit(required)npm run test:integration(if needed)npm run test:e2e(if needed)Results: 243 passed, 1 failed. The single failure is
sqlite-storemodule load error (EBUSY: resource busy or locked, unlink), which is an environment-level file lock issue on Windows unrelated to this documentation change.Impact / Risk
Low risk — pure documentation update with no code changes. Aligns documentation with existing behavior rather than changing behavior.
Checklist
tests/README.mdstructuredocs/en+docs/zh-CNformat rulesdist/changes (unless release)