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!

CommentFileSizeAuthor
#2 text_summary_options-README-3002615-2.patch1.9 KBalonaoneill

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

alonaoneill commented
Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new text_summary_options-README-3002615-2.patch1.9 KB

I uploaded a patch that adds some useful configurations and links.
Thanks for the work on this project!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: Unassigned » volkswagenchick
Issue tags: +DrupalCorn18

Tagging for training session at Drupal Corn 2018

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
Status: Needs review » Reviewed & tested by the community

Changes look good. I checked for grammar, spelling, and punctuation. All links and configs work as expected.

Patch applied using simplytest.me

Marking as RTBC

  • rcodina committed e8e342a on 8.x-1.x authored by alonaoneill 
    Issue #3002615 by alonaoneill: README configs and useful links
rcodina’s picture

rcodina
Primary language Catalan
Location Barcelona
commented
Status: Reviewed & tested by the community » Fixed

Thanks!

rcodina’s picture

rcodina
Primary language Catalan
Location Barcelona
commented
Status: Fixed » Closed (fixed)