Module Documentation

Module Documentation allows you to append notes to your installed modules, so you can document how they are used on the site.

This is heavily inspired by Module Usage Documentation.

Improvements over that module:

1. jQuery UI not required
2. Uses entity api for module tracking records
3. Uses standalone documentation listing, much faster than drupal's module list
4. Improved module detail page
5. Better version detection, falls back to composer if .info is missing, or dev version installed
6. Faster entry of documentation

Features

• Add usage notes to modules
• Track module installation/upgrade date and version
• Module page provides information on version/dependencies
• Module page shows config dependencies, and LINKS TO THE EDIT FORM FOR THEM!!

Post-Installation

Inspect your site's modules at /admin/modules/documentation.
Or Admin > Extend > Module documentation.

Inspect modules or add notes via the listing.

View uninstalled modules list (previously installed), notes, and module activity listings.

Check out the config inspector/edit links on the module detail page!

Additional Requirements

None.

Recommended modules/libraries

None.

Similar projects

Module Usage Documentation - alternative
Content Model Documentation - additional site documentation

Supporting this Module

Issues/patches are welcome!

Community Documentation

None (yet).