rails-engine-docs
Installation
SKILL.md
Rails Engine Docs
Use this skill when the task is to write or improve documentation for a Rails engine.
Engine docs should optimize for host-app adoption. Readers need to know what the engine does, how to install it, how to configure it, and where the boundaries are. All generated documentation (README, guides, examples) must be in English unless the user explicitly requests another language.
Quick Reference
| Doc Section | Purpose |
|---|---|
| Purpose | What the engine does and when to use it |
| Installation | Gemfile, bundle install, install generator |
| Mounting / initialization | Where and how to mount the engine (routes, initializer) |
| Configuration | Options, defaults, required vs optional |
| Usage examples | Copyable code showing typical workflows |
| Migrations / operational steps | Install migrations, run generators, one-time setup |
| Extension points | Adapters, callbacks, config blocks for customization |
| Development and testing | How to run tests, contribute, or develop locally |