We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation.

Follow this pattern
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

CommentFileSizeAuthor
#4 3320054-4.patch1.61 KBshubham rathore
#2 3320054-#2.patch133 bytesPracheth

Issue fork pingme-3320054

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

Pracheth created an issue. See original summary.

Pracheth’s picture

Pracheth commented
Status: Active » Needs review
StatusFileSize
new 3320054-#2.patch133 bytes

Updated to README.md format.
Please review the same.

shubham rathore’s picture

shubham rathore commented
Assigned: Pracheth » shubham rathore
shubham rathore’s picture

shubham rathore commented
Assigned: shubham rathore » Unassigned
StatusFileSize
new 3320054-4.patch1.61 KB

Hi please review this patch.

Sonal Gyanani made their first commit to this issue’s fork.

Sonal Gyanani opened merge request !2

ressa’s picture

ressa
he/him
commented
Status: Needs review » Needs work

Great work @Shubham Rathore, just a few details.

Sonal Gyanani’s picture

Sonal Gyanani commented
Status: Needs work » Needs review
ressa’s picture

ressa
he/him
commented

Thanks @Sonal Gyanani, looks good now.

Having two lists after each other under "Introduction" renders them with extra spaces, so maybe let's combine them. Please review.

Sonal Gyanani’s picture

Sonal Gyanani commented

Thanks @ressa, good suggestion but I think those points are not part of features So remove bullets from those points under introduction.
Please review

ressa’s picture

ressa
he/him
commented

Perfect solution @Sonal Gyanani, thanks! I updated the configuration section, and removed redundant "Supporting by:". Please review.

Sonal Gyanani’s picture

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

Thanks @ressa, looks good now.
Moving it to RTBC

heni_deepak’s picture

heni_deepak commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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