Let module help fallback to help_topic:mymodule.about

Created on 16 April 2019, almost 6 years ago
Updated 7 May 2023, over 1 year ago

Problem/Motivation

When we have #2920309: Add experimental module for Help Topics , help topic pages are gathered in mymodule/help_topics/mymodule.foo.html.twig

As a module owner, it provides value to users to have a canonical entry point per module. But currently i have no way to author the module help page via help_topics, i have to implement hook_help.

Proposed resolution

* If module help is not implemented by hook_help, show the result of the "about" help topic of the module. (Which then usually is not "top_level" so it will not be shown in topics.

Whether or not to deprecate the module-help part of hook_help (or the hook altogether) is not part of this issue, but may or may not be a followup.

Remaining tasks

Decide, implement.

User interface changes

None.

API changes

Module help can be provided by module.about help topic.

Data model changes

None.

Release notes snippet

TBD

Feature request
Status

Active

Version

10.1

Component
Help 

Last updated 24 days ago

No maintainer
Created by

🇩🇪Germany geek-merlin Freiburg, Germany

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.71.5 2024