document-engine
Installation
SKILL.md
Document Engine
Use this skill when writing or maintaining documentation for Rails engines.
Core Process & Constraints
| Step | Section | Focus |
|---|---|---|
| 1 | Installation | gem add, bundle, run install generator — show minimum working path first |
| 2 | Host Assumptions | Explicitly state any host model, job backend, or auth integration assumptions |
| 3 | Configuration | All options with defaults, required vs optional |
| 4 | Mounting | Explicit mount MyEngine::Engine, at: '/path' in routes — show once only |
| 5 | Usage | Copyable code for typical workflows |
| 6 | Migrations | Install generator, one-time setup, upgrade-impacting changes |
Hard gate: All generated documentation MUST satisfy steps 1, 2, and 3 above before proceeding to optional sections.
README snippet (install + mount):