While evaluating this module, while it has a readme, I noticed the readme could use some helpful links (permalinks as opposed to aliases) 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!

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
StatusFileSize
new2.68 KB

I uploaded a patch that aligns the readme to Drupal documentation standards, thanks!!

alonaoneill’s picture

Status: Needs review » Needs work

Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good, but patch did not apply!
Marking as Need work.
Thank you for working on module!

volkswagenchick’s picture

Status: Needs work » Needs review

hhmm. i am unable to apply any of the patches I have made. Will re-approach this one next week.

volkswagenchick’s picture

Status: Needs review » Needs work
dani3lr0se’s picture

Status: Needs work » Reviewed & tested by the community

The patch applies cleanly locally for me. Simplytest.me doesn't like it for some reason, but formatting, spelling, grammar and readability all look good. Makes sense and easy to follow. It aligns with Drupal standards as well. Thanks for the patch @volkswagenchick. :)

bemarlan’s picture

Version: 8.x-1.x-dev » 8.x-1.1
Status: Reviewed & tested by the community » Fixed

Fixed in new release 8.x-1.1

Status: Fixed » Closed (fixed)

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