Skip to content

chore: add skill guide docs - #5

Merged
yordis merged 1 commit into
mainfrom
chore-2
Feb 12, 2026
Merged

chore: add skill guide docs#5
yordis merged 1 commit into
mainfrom
chore-2

Conversation

@yordis

@yordis yordis commented Feb 12, 2026

Copy link
Copy Markdown
Member

Signed-off-by: Yordis Prieto yordis.prieto@gmail.com

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@coderabbitai

coderabbitai Bot commented Feb 12, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

Walkthrough

A comprehensive skill-authoring guide is introduced, detailing how to structure and author skills with SKILL.md manifests. The guide covers YAML frontmatter fields, best practices for descriptions, workflow organization, structural principles, maintenance practices, anti-patterns, and skill sizing recommendations.

Changes

Cohort / File(s) Summary
Skill Authoring Documentation
docs/skill-authoring-guide.md
New 438-line guide covering skill definition, SKILL.md manifest structure (YAML frontmatter and markdown body), frontmatter fields (name, description, allowed-tools), description guidelines, workflow structuring, best practices, maintenance practices, anti-patterns, examples, and skill sizing considerations.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A guide for crafting skills so fine,
With manifests and paths aligned,
From YAML's form to markdown's way,
These skills shall shine and save the day!
📚✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore-2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@yordis
yordis marked this pull request as ready for review February 12, 2026 21:36
@yordis
yordis merged commit 0d70544 into main Feb 12, 2026
2 of 3 checks passed
@yordis
yordis deleted the chore-2 branch February 12, 2026 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant