- Issue created by @prashant.c
- First commit to issue fork.
- Status changed to Needs review
about 1 year ago 11:20am 1 December 2023 Verified MR5 on 9.5.x, the hook_help is added. Added screenshots for reference, RTBC++
- 🇮🇳India prashant.c Dharamshala
@Tanuja Bohra
Thanks for making the efforts to test it however IMHO screenshots were not required in this case.
Thanks!
- Status changed to Needs work
about 1 year ago 11:16am 22 December 2023 - 🇮🇳India Anjali Mehta
I have reviewed the MR5, and the hook only returns the content of the README.md file. However, this is not sufficient as it should provide a more helpful overview for other developers and users. Instead of just including the README content, the hook should incorporate an informative help page with a standardized structure.
The updated help page should include the following sections:
About section
giving a brief overview of what the module does, starting with text like "The Foo Bar module [verb]", and finishing with a standardized link to the module's online documentation.
Uses section
giving details of module functionality and explaining what users can do, and links to the URLs where each specific functionality can be accessed.By incorporating these improvements, the help page will become more informative and user-friendly.
Changing the status back to NW
Thank you.