Craft User Manual

Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a "User Manual" or "Help" section directly in the control panel.

---

Installation

1. Copy the included UserManual folder into craft/plugins.
2. Navigate to Plugins in the Craft CP.
3. Click the Install button in the row for the UserManual plugin.
4. Select the section the plugin should use as the User Manual page in the CP.
5. Click the User Manual link in the CP nav.

Some notes

• The plugin currently only pulls in the body field from each entry in the selected section.
• While the User Manual section works best with Structures, you can certainly get away with using a one-off Single (I'm looking at you Craft Personal users!).
• If you're running Craft Client or Craft Pro make sure your content editors don't have permission to edit whatever section you've selected to use as your User Manual

Thanks

This plugin was inspired by the team over at 70kft for their work on Craft-Help. While their plugin is definitely more flexible in terms of writing custom markdown in separate files, we wanted to create something that would make it easier for anyone to edit documentation without making any changes to the server. This works particularly well for larger projects where more than one person (especially non-devs) are writing documentation for how to use the CMS.

Releases

• 1.0.0 - Initital release of Craft User Manual.

We hope this plugin is useful, and we'd love to hear any suggestions or issues you may have. @erskinerob.