You can add hook help .module file

<?php

use Drupal\Core\Routing\RouteMatchInterface;

/**
* Implements hook_help().
*/
function YOUR_MODULE_help($route_name, RouteMatchInterface $route_match) {
switch ($route_name) {
case 'help.page.YOUR_MODULE':
return '

' . t('This is a description of what your module does.') . '

';
}
}

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

kishan@lnwebworks created an issue. See original summary.

sanskar mishra’s picture

StatusFileSize
new399 bytes

Implemented hook help

sanskar mishra’s picture

viren18febS made their first commit to this issue’s fork.

viren18febs’s picture

Status: Active » Needs review
StatusFileSize
new765 bytes

I have implement hook_help function & added patch file, please review.

kenyoowen’s picture

Status: Needs review » Needs work
StatusFileSize
new212.02 KB

Hi viren18febS

I applied and tested your patch and reviewed the changes the help page is not helpful since you only added the README.txt. The help page should be something that should help you configure the module. Please look at the screenshot I attached for your reference.

Thank you

viren18febs’s picture

Status: Needs work » Needs review
StatusFileSize
new105.92 KB

@kenyoOwen, There is no configuration for this module, you can check the help page, here is the section for "## How To Use" the module. added image for reference.

sanskar mishra’s picture

StatusFileSize
new914 bytes

Using read.me file updated hook help for the module.

Please review

adwivedi008’s picture

Version: 1.0.0 » 1.0.2
Status: Needs review » Needs work

Hi everyone, Thanks for working on the issue
Can someone create a merge request with the latest changes

deepak5423 made their first commit to this issue’s fork.

deepak5423’s picture

Status: Needs work » Needs review

@adwivedi008 please review

silvi.addweb’s picture

Status: Needs review » Needs work

Need to Modified as per standards of help page.

silvi.addweb’s picture

Status: Needs work » Needs review
atul_ghate’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new155.14 KB

I have reviewed and applied your changes (MR 5), looks good to me moving to RTBC( attached the screenshot of help page) .

adwivedi008’s picture

Status: Reviewed & tested by the community » Fixed

Merged on 1.0.x
Will create a release soon

adwivedi008’s picture

Version: 1.0.2 » 1.0.x-dev
Status: Fixed » Closed (fixed)