eventaservo-yard-docs

Generate English YARD documentation for Ruby classes, modules, and methods.

31|8|Updated Oct 11, 2018

Search Tags:#documentation #ruby #rails #english #code-comments #api-docs #yard

Ready to run

npx skills add https://github.com/eventaservo/eventaservo --skill eventaservo-yard-docs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: eventaservo-yard-docs
Source: https://github.com/eventaservo/eventaservo/tree/main/.agents/skills/eventaservo-yard-docs
Command: npx skills add https://github.com/eventaservo/eventaservo --skill eventaservo-yard-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates consistent, English-language YARD documentation for Ruby code to improve API clarity and maintainability across a Rails project.

Core Features & Use Cases

Create or update YARD docs for classes, modules, and methods in app/, lib/, or config/.
Enforce English language for all YARD text and tag content (e.g., @param, @return, @example).
Provide examples and references to related classes or modules with @see when relevant.

Quick Start

Provide a Ruby class or method and request a full YARD-compliant docblock in English.

Frequently Asked Questions about eventaservo-yard-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate YARD documentation for Ruby code automatically?▼

To generate YARD documentation for Ruby code, provide a class, module, or method to receive a full YARD-compliant docblock. It covers service objects, models, and controllers within app/, lib/, and config/ directories.

Can I enforce English-only text in YARD docs for a Rails project?▼

Yes, you can enforce English-only text in YARD docs for a Rails project. The generated documentation strictly applies English language rules to all YARD text and tag content, including @param, @return, and @example tags.

What is the best way to add @see tags and examples to Ruby API docs?▼

The best way to add @see tags and examples to Ruby API docs is to generate them contextually. The documentation process automatically includes relevant examples and references to related classes or modules when applicable.

Does YARD support frontmatter-based metadata for Ruby service objects?▼

Yes, YARD supports frontmatter-based metadata for Ruby service objects. The documentation generation process satisfies frontmatter requirements while documenting typical scenarios like service objects, models, and controllers.

How do I document methods in config/ directories using YARD?▼

To document methods in config/ directories using YARD, apply the documentation generator to the target code. It identifies and documents Ruby code clearly across app/, lib/, and config/ paths.

When do I need to update existing YARD docblocks in a Ruby on Rails application?▼

You need to update existing YARD docblocks in a Ruby on Rails application when API clarity and maintainability decline. Providing the Ruby class or method allows the tool to create or update the YARD documentation consistently.