Replace README.txt with README.md

Created on 2 February 2023, almost 2 years ago
Updated 12 May 2023, over 1 year ago

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...

📌 Task
Status

Closed: won't fix

Version

3.0

Component

Documentation

Created by

🇮🇳India Sonal Gyanani

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @Sonal Gyanani
  • @sonal-gyanani opened merge request.
  • Issue was unassigned.
  • Status changed to Needs review almost 2 years ago
  • 🇮🇳India Sonal Gyanani

    Created MR for the issue.
    Please review.
    Thanks

  • Assigned to Kamlesh Kishor Jha
  • Issue was unassigned.
  • Status changed to RTBC almost 2 years ago
  • 🇮🇳India Kamlesh Kishor Jha Jaipur

    MR looks good to me.
    So moving it to RTBC

  • Status changed to Needs work almost 2 years ago
  • 🇺🇸United States tr Cascadia

    Changing the format to .md doesn't contribute anything to this module - what needs to be done is to update and correct the information in README.txt. It doesn't make any sense to me to change the format and still keep the wrong content. Besides, Drupal core has NOT standardized on .md as a README format yet, and while having a README.md may be useful in some cases it causes problems in other cases. I don't think we should change the format until core Drupal defines a policy for README files and provides a way to display .md natively in Drupal.

  • Status changed to Closed: won't fix over 1 year ago
  • 🇺🇸United States tr Cascadia
Production build 0.71.5 2024