ti-add-comments

Add ti-doc and ti-for-llm comments to MRuby code files.

71|2|Updated Sep 2, 2025
One-click install
npx skills add https://github.com/engneer-hamachan/mruby-ti --skill ti-add-comments
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ti-add-comments
Source: https://github.com/engneer-hamachan/mruby-ti/tree/main/skills/ti-add-comments
Command: npx skills add https://github.com/engneer-hamachan/mruby-ti --skill ti-add-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ti-add-comments provides a disciplined method to annotate MRuby code with ti-doc and ti-for-llm comments, enabling AI agents to understand functions and important code sections without reading source.

Core Features & Use Cases

  • Automatically insert ti-doc above every function definition to describe its purpose.
  • Include ti-for-llm annotations for important non-function code to provide context to LLMs.
  • Enforce English-only comments and a consistent commenting style to improve AI understanding and maintainability.
  • Use case: prep MRuby projects for ti’s llm navigation and type-check integration, facilitating code reviews and editor support.

Quick Start

Run ti-add-comments {file name}.rb to annotate the MRuby source file with ti-doc and ti-for-llm comments.

Frequently Asked Questions about ti-add-comments

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

FAQPage Schema
How do I add comments to MRuby code to improve LLM navigation?

You can add comments to MRuby code using ti-doc and ti-for-llm annotations. This approach inserts descriptions above function definitions and important code blocks, enabling AI agents to understand the source without reading it directly.

What is the best way to prepare MRuby projects for AI type-check integration?

The best way to prepare MRuby projects for AI type-check integration is applying ti-doc and ti-for-llm comments. This enforces a consistent, English-only commenting style above def statements, supporting LLM output and better maintainability.

How does annotating MRuby code with ti-doc help code reviews?

Annotating MRuby code with ti-doc helps code reviews by providing automatic documentation of methods and important code blocks. This gives editors and AI agents immediate context, facilitating better code reviews and maintainability.

Can I use automatic documentation comments for non-function code blocks in MRuby?

Yes, you can use ti-for-llm annotations for non-function code blocks in MRuby. While ti-doc goes above function definitions, ti-for-llm provides context for important non-function code to help LLMs understand the logic.

Does ti-add-comments require specific comment placement and language rules?

Yes, ti-add-comments enforces English-only comment rules and requires precise placement above def statements. This consistent annotation style is necessary for generating valid ti-doc and ti-for-llm comments.

What is the workflow for generating and validating ti-doc comments in MRuby?

The workflow for generating ti-doc comments involves running a command on your MRuby source file to automatically insert annotations. It then enforces a repeatable process for validating that the English-only comments are correctly placed.