Skills
.Work. You
Rest

rails-engine-docs

Community

Document Rails engines with host-app ready docs.

Software Engineering#documentation#readme#configuration#guides#installation#mounting#rails-engine
Authorigmarin
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Streamlines the creation and maintenance of Rails engine documentation by providing clear structure, language guidelines, and host-focused guidance.

Core Features & Use Cases

  • Purposeful README shapes: Enforces a consistent layout with sections for purpose, installation, mounting, configuration, usage, migrations, and development notes.
  • Language and audience clarity: Ensures outputs are in English and tailored for host apps adopting the engine.
  • Guided examples: Includes practical examples and templates to accelerate documentation creation for new or existing engines.

Quick Start

Document a Rails engine by following the recommended README shape and include install, mount, configuration, and example usage.

Dependency Matrix

Required Modules

None required

Components

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: rails-engine-docs
Download link: https://github.com/igmarin/rails-agent-skills/archive/main.zip#rails-engine-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.