ruby-yard-documenter
CommunityDocument Ruby code with YARD
Authorlekemula
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the process of adding comprehensive YARD documentation to Ruby code, improving code clarity, maintainability, and discoverability.
Core Features & Use Cases
- Automated Documentation Generation: Identifies and adds YARD tags for classes, modules, and methods.
- Intelligent Tagging: Uses Solargraph LSP to infer return types and exclude private/trivial methods.
- Style Consistency: Adheres to project-specific YARD conventions for tone and tag usage.
- Use Case: A developer needs to document a complex Ruby gem before releasing it. This Skill can automatically generate the initial YARD documentation, saving significant time and ensuring a consistent style.
Quick Start
Add YARD documentation to the file at $ARGUMENTS.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: ruby-yard-documenter Download link: https://github.com/lekemula/dotfiles/archive/main.zip#ruby-yard-documenter Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.