Commit d4238e55 authored by volkswagenchick's avatar volkswagenchick Committed by gnuget
Browse files

Issue #2899117 by volkswagenchick, loopduplicate: README for D8 branch should...

Issue #2899117 by volkswagenchick, loopduplicate: README for D8 branch should conform to documentation standards
parent ed80f440
......@@ -12,11 +12,16 @@ CONTENTS OF THIS FILE
INTRODUCTION
------------
The Advanced help module allows module developers to store their help outside the module system, in pure .html or .md (MarkDown) files. It provides a framework that allows module and theme developers to integrate help texts in a Drupal site, as well as exposing help to site administrators through the administrative interface.
The Advanced Help module allows module developers to store their help outside
the module system, in pure .html or .md (MarkDown) files. It provides a
framework that allows module and theme developers to integrate help texts in a
Drupal site, as well as exposing help to site administrators through the
administrative interface.
* For a full description of the module visit https://www.drupal.org/node/2461741
* To submit bug reports and feature suggestions, or to track changes visit https://www.drupal.org/project/issues/advanced_help
* To submit bug reports and feature suggestions, or to track changes visit
https://www.drupal.org/project/issues/advanced_help
REQUIREMENTS
......@@ -28,19 +33,26 @@ This module has no required dependencies outside of Drupal core.
RECOMMENDED MODULES
-------------------
* Advanced help hint - If Advanced help is not enabled, this module will generate a hint string that can be used in the project's hook_help to hint that Advanced help should be enabled. (https://www.drupal.org/project/advanced_help_hint)
* Advanced Help Hint (https://www.drupal.org/project/advanced_help_hint):
If Advanced Help is not enabled, this module will generate a hint string that
can be used in the project's hook_help to hint that Advanced Help should be
enabled.
INSTALLATION
------------
* Install the Advanced help module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further information.
Install the Advanced Help module as you would normally install a contributed
Drupal module. Visit https://www.drupal.org/node/895232 for more information.
CONFIGURATION
--------------
By itself, this module doesn't do much. The Advanced help assists other modules and themes in showing help texts. Nothing will show up until you enable at least one other module that makes use of the advanced help framework or comes with a file named README.md or README.txt.
By itself, this module doesn't do much. It assists other modules and themes in
showing help texts. Nothing will show up until you enable at least one other
module that makes use of the Advanced Help framework or comes with a file named
README.md or README.txt.
MAINTAINERS
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment