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
#9 README.md2.89 KBravi kant
#6 3320701 - after applying MR.png223.2 KBkenyoowen
#4 Style_Options.png195.57 KBnupur badola

Issue fork style_options-3320701

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 opened merge request !6

Pracheth’s picture

Pracheth commented
Assigned: Pracheth » Unassigned
Status: Active » Needs review

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

nupur badola’s picture

nupur badola commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Style_Options.png195.57 KB

Patch is working and marking it to RTBC.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Priority: Normal » Minor
Status: Reviewed & tested by the community » Needs review

It would be better if somebody else reviews the MR.

kenyoowen’s picture

kenyoowen commented
Status: Needs review » Needs work
StatusFileSize
new 3320701 - after applying MR.png223.2 KB

Hi Pracheth

I applied and reviewed your MR it does replace README.txt with README.md, but it doesn't follow README.md template Please see the screenshots attached.

Thank you.

ravi kant made their first commit to this issue’s fork.

ravi kant opened merge request !18

ravi kant’s picture

ravi kant commented
StatusFileSize
new README.md2.89 KB

Not able to push changes on this ticket.
Attaching updated readme file.

Anjali Mehta made their first commit to this issue’s fork.

anjali mehta’s picture

anjali mehta commented
Status: Needs work » Needs review

apaderno changed the visibility of the branch 3320701-readme-file-update to hidden.

nupur badola’s picture

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

Reviewed MR!6, the file is updated as per the readme.md file template.
Hence, marking it to RTBC.

  • pixelwhip committed f53b08af on 1.0.x authored by Pracheth 
    Issue #3320701 by Pracheth, apaderno, ravi kant, Anjali Mehta, Nupur...
pixelwhip’s picture

pixelwhip commented

Thanks for all your work on this. Merged!

pixelwhip’s picture

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

Status: Fixed » Closed (fixed)

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