While evaluating this module, while it has a readme, I noticed the readme could use some helpful links and configurations. Also, the formatting does not align to Drupal standards for documentation. There should be a clear table of contents and lines should be hard wrapped at 80 characters for better accessibility.

According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....

https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Patch to follow, thanks!

CommentFileSizeAuthor
#2 context-README-3007934-2.patch3.93 KBvolkswagenchick
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
FileSize
3.93 KB

I uploaded a patch the updates the existing readme to include some useful links and reformats it to align to Drupal documentation standards (helps with readability)

Thanks!!

alonaoneill’s picture

Assigned: Unassigned » alonaoneill
Status: Needs review » Reviewed & tested by the community

Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good. Patch applied.
Marking as RTBCed.
Thank you for working on module!

boshtian’s picture

Thanks for the updates. It definitely looks nicer.

boshtian’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.