Configurable Help

The core's help Help Topics feature allows modules, themes, and install profiles to define topics that appear in the Help Topics section on admin/help. It is available from Drupal core 10.2 or later, and install the Configurable Help module from the Extend page.

This project, "Configurable Help" defines a configuration entity, which allows site builders to use the Drupal administrative UI to define, share, and deploy additional help topics. There is a README.txt file in this project with more information, and also some help topics under the heading "Building a help system" if you install this module in a Drupal Core 8/9 site.

Current status

(23 March 2024)

Finished initial roadmap about getting Help Topics to be a stable module: #3027054: Help Topics module roadmap: the path to beta and stable

(This section last updated 7 January 2021)

If you used old versions of this module... they are not compatible with current versions. Sorry about that! Lots of things happened as we got the patch into Drupal Core, and this was always a Sandbox.

This module will not get a full release until the core Help Topics module is more stable. I will be attempting to maintain this module compatible with that one as it evolves, and I will try to keep this module as stable as possible, but there are no guarantees.

If you were using this Sandbox module prior to August 5, 2019, my advice would be to:
- Copy the HTML source for any help topics you made to text files
- Uninstall the old version of this module
- Update to Drupal Core development version 8.8.x or later
- Install the core experimental Help Topics module
- Update this module and install it
- Paste the HTML source you saved into new help topics and save them.