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
#5 ajax_comments-README-fix-3063795-5.patch6 KBalonaoneill
#2 ajax_comments-README-fix-3063795-2.patch6 KBalonaoneill

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

alonaoneill commented
StatusFileSize
new ajax_comments-README-fix-3063795-2.patch6 KB
alonaoneill’s picture

alonaoneill commented
Assigned: alonaoneill » Unassigned
Status: Active » Needs review
jqtnguyen’s picture

jqtnguyen commented
Status: Needs review » Needs work

Please consider the following feedback, which includes changes to conform with Drupal.org documentation standards at https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

  1. +++ b/README.md
@@ -0,0 +1,98 @@
+    2. Navigate to Administration > Configuration > Content Authoring > AJAX comments

    Text should manually word-wrap within around 80 cols.

  2. +++ b/README.md
@@ -0,0 +1,98 @@
+ * Troubleshootling

    Typo: change to "Troubleshooting". 

  3. +++ b/README.md
@@ -0,0 +1,98 @@
+    2. Navigate to Administration > Configuration > Content Authoring > AJAX comments

    Text should manually word-wrap within around 80 cols.

  4. Also, consider re-arranging the Table of Contents so that "Configuration" appears before "Troubleshooting".
alonaoneill’s picture

alonaoneill commented
Status: Needs work » Needs review
StatusFileSize
new ajax_comments-README-fix-3063795-5.patch6 KB

I made changes.
Thanks!

jqtnguyen’s picture

jqtnguyen commented
Status: Needs review » Reviewed & tested by the community

Changes look good, and patch applies smoothly on Simplytest.me. Marking RTBC.

  • qzmenko committed deb43e2 on 8.x-1.x authored by alonaoneill 
    Issue #3063795 by alonaoneill: Existing README needs some formating
qzmenko’s picture

qzmenko
Primary language Russian
Location Novosibirsk
commented

Committed and pushed. Thanks!

qzmenko’s picture

qzmenko
Primary language Russian
Location Novosibirsk
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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