Each page in the administration can have a corresponding help page. If help is available a link will appear on page, when the user clicks on it, it pops up in an overlay.

The admin backend discovers the help by looking to see if there is a corresponding template in the help directory. It could use a simple convention based on the current module, controller and action.

For example the request to /admin/content/page/edit would map to the help file in ./help/content/page/edit.html.*

Storage

The actual help text itself is stored in a series of templates, which can be in any template language you choose, although generally we’d prefer it if they were written using HAML.

Help in Slices

A slice can specify custom paths. These can be used to register the location of help files for a slice.

Forum.push_path(:help, Forum.root / "help")

Gluttonberg can then easily locate and parse these help files when it needs to.