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

CommentFileSizeAuthor
#7 Screenshot from 2023-03-15 10-22-45.png94.08 KBdineshkumarbollu

Issue fork roleassign-3337801

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

Sonal Gyanani created an issue. See original summary.

Sonal Gyanani opened merge request !2

Sonal Gyanani’s picture

Sonal Gyanani commented
Assigned: Sonal Gyanani » Unassigned
Status: Active » Needs review

Created MR for the issue.
Please review.
Thanks

renatog’s picture

renatog commented
Status: Needs review » Needs work

The conversion is good but I think we can take the opportunity and include the maintainers section and Table of Contents (TOC)

renatog’s picture

renatog commented
Status: Needs work » Needs review

'

renatog’s picture

renatog commented

Update the MR with that suggestion, adding the Maintainers and Table of Content following the README template

dineshkumarbollu’s picture

dineshkumarbollu commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Screenshot from 2023-03-15 10-22-45.png94.08 KB

Hi Team

I reviewed MR !2 it looks fine according to README.md Template.

Thanks

dineshkumarbollu’s picture

dineshkumarbollu commented

nord102 made their first commit to this issue’s fork.

nord102’s picture

nord102
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

  • nord102 committed 2ab290f7 on 2.0.x 
    Issue #3337801: Replace README.txt with README.md

Status: Fixed » Closed (fixed)

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