[meta] Add hook_help()/help_example to Examples for Developers modules

+++ b/examples.module
@@ -27,6 +28,35 @@ use Drupal\Core\Url;
  */
...
+   $output = '';

Let's have a look at this issue to avoid lots of text, did you ran it through phpcs? It might have thrown an error of coding standards related to concatenation with t() function.

See: #2660058: [meta] Convert controller content to twig {% trans/endtrans %} templates per module

Updated the patch with coding standards and as mentioned in #5

Re-rolled the patch.

Kindly review.
Thanks!

Thanks for working on this.

As much as possible we want to use twig translatable templates for big blocks of content like this. Examples has Drupal\examples\Utility\DescriptionTemplateTrait to help out with this in controllers. I'd guess it would work returning appropriate markup for hook_help() as well.

We've also historically had some conversations as to whether Examples modules should always have hook_help(): #2123195: [policy] Change approach on end user ui We want to err on the side of having useful explanatory content on the page, rather than relying on help text, but both could work if presented properly.

If you want to talk about whether to add hook_help() to some or all of these modules, let's have that conversation here. Then we can open sub-issues as needed to add hook_help() to the different modules.

We should also consider adding an example of how to use hook_help(), both with and without the twig templating system.

Rescoping this issue to be a PLAN.

Erp... Wait a minute. I made a mistake. :-)

This sets the help displayed in the module information page, rather than the help at the top of the page. That's a great idea, and we should do that for each module.

But we definitely want to use the twig template scheme to provide this content, so that it's translatable and doesn't make the code part of the module confusing. We want minimal how-to documentation in each example module for this help system.

We also want a follow-up to make a help_example so we can provide detailed documentation for all these things in that module, without having to provide a lot of confusing documentation within all the other modules.

Thanks. :-)