From rails-agent-skills
Generates README templates, installation/configuration guides, mount instructions, extension APIs, and migration notes for Rails engines. Use when writing or maintaining engine docs.
npx claudepluginhub igmarin/rails-agent-skills --plugin rails-agent-skillsThis skill uses the workspace's default tool permissions.
All generated documentation (README, guides, examples) must be in **English** unless the user explicitly requests another language.
Guides creating, scaffolding, or refactoring Rails engines, covering types (Plain, Railtie, Engine, Mountable), namespace isolation, host-app contracts, and file structure.
Generates thorough README.md files covering local setup, system architecture, and production deployment after deep codebase analysis. Activates on 'write readme' or project documentation requests.
Generates step-by-step installation guides, configurations, and code for technical documentation including READMEs, API docs, and user guides. Activates on 'installation guide creator' phrases.
Share bugs, ideas, or general feedback.
All generated documentation (README, guides, examples) must be in English unless the user explicitly requests another language.
mount MyEngine::Engine, at: '/path' in routesSee CHECKLIST.md for the full gap checklist. Critical gaps: installation steps, all config options with defaults, explicit mount path, migration timing, host model/auth assumptions.
README snippet (install + mount):
## Installation
Add to your Gemfile:
gem 'my_engine'
Run:
bundle install
rails generate my_engine:install
This creates `config/initializers/my_engine.rb`. Mount the engine in `config/routes.rb`:
mount MyEngine::Engine, at: '/admin'
Configuration section:
## Configuration
In `config/initializers/my_engine.rb`:
MyEngine.configure do |config|
config.user_class = "User" # required: host model for current user
config.widget_count = 10 # optional, default 10
end
When asked to write docs:
| Skill | When to chain |
|---|---|
| rails-engine-author | Host-app contract, structure, extension points to document |
| rails-engine-installers | Install generators, setup steps to document |
| rails-engine-release | Changelog, upgrade notes, version documentation |
| api-rest-collection | When documenting or adding API endpoints (keep Postman collection in sync) |