Replace README.txt with README.md

Created on 18 November 2022, over 1 year ago
Updated 28 November 2023, 7 months 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 the pattern in the README.md template .

📌 Task
Status

RTBC

Version

1.2

Component

Documentation

Created by

🇮🇳India Raghavendra A M

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

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Merge request !3Updated README.txt to README.md → (Open) created by Raghavendra A M
  • 🇮🇳India Bushra Shaikh

    Verified the MR!3 tested, got error after applying patch .

    git apply 3.diff.txt.patch.txt
    3.diff.txt.patch.txt:40: trailing whitespace.
    ```
    warning: 1 line adds whitespace errors.
  • Status changed to Needs work 12 months ago
  • 🇮🇳India kavitha@specbee.com

    After applying patch, got the below error:
    3.patch:40: trailing whitespace.
    ```
    warning: 1 line adds whitespace errors.

  • First commit to issue fork.
  • Status changed to Needs review 8 months ago
  • 🇧🇪Belgium Frederikvho Belgium

    I removed the trailing whitespace. Please review !MR3.

    'The supporting organization' section is not required, right? As it's in the module settings already.

    Kind regards

  • Status changed to Needs work 8 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi Frederikvho

    I reviewed MR!3 and in Project name and introduction missing project page and issue queue links for the module. Sample of Project page and Issue queue based on README.md template.

    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/admin_menu).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/admin_menu).

    Thank you

  • Assigned to nitin_lama
  • Status changed to Needs review 7 months ago
  • 🇮🇳India nitin_lama

    Please review.

  • Issue was unassigned.
  • Status changed to Needs work 7 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi nitin_lama

    I reviewed your changes and confirmed that you added "project page and issue queue" links but the Project page text is duplicated and it has a colon symbol while in the README.md template there isn't a colon symbol.

    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/admin_menu).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/admin_menu).

    Thank you.

  • First commit to issue fork.
  • Status changed to Needs review 7 months ago
  • 🇮🇳India sourabhjain

    Updated changes suggested in #16. Please review.

  • Status changed to RTBC 7 months ago
  • 🇵🇭Philippines kenyoOwen

    Hi sourabhjain

    I reviewed your changes and confirmed that it removed the colon symbol and duplicate text of the "Project page". The README.md is following the README.md template.

    Thank you.

Production build 0.69.0 2024