Unify Module/Theme Help Support

Created on 29 June 2019, almost 5 years ago
Updated 17 October 2023, 8 months ago

It is useful to have Help support when considering, using or configuring a module. The help module provides a limited set of hooks. Including additional webpages requires hook support. Other features such as a link in the help text back to the Drupal webpage for the module is something that must be embedded within HTML text.

Note, this request is not addressing help from a site's user perspective.

It would be useful if there were something like a module.help.yml and a module.documentation.html file. The yml file could provide the help for the module when it is in the Extend list as well as on the Drupal site on the module page. A yml file allows more structured help definitions that could provide multiple pages. It would even be possible to provide help associated with other spots within admin pages and likewise automatically have links from that help content back to the module's help which would now be a more structured collection. For example, help support could easily be tied to permissions. Right now there is no easy way to determine what permissions are associated with a module.

A standard html file in the git archive could be referenced from the module's Drupal page. Many modules have no online documentation available and documentation should not really be part of the module description.

✨ Feature request
Status

Closed: outdated

Version

11.0 πŸ”₯

Component
HelpΒ  β†’

Last updated 10 days ago

No maintainer
Created by

πŸ‡ΊπŸ‡ΈUnited States bwong

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.69.0 2024