Replace README.txt to Readme.md file

Created on 24 April 2023, over 1 year ago
Updated 12 August 2024, 4 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

https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... โ†’

๐Ÿ“Œ Task
Status

Needs work

Version

1.3

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia Manoj Raj.R Chennai

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

Merge Requests

Comments & Activities

  • Issue created by @Manoj Raj.R
  • Merge request !1Update README.txt โ†’ (Open) created by Manoj Raj.R
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Manoj Raj.R Chennai

    Updated the Readme file template according like here

    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... โ†’

    Please review.

  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Manoj Raj.R Chennai
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Bushra Shaikh

    I applied MR!1 for Drupal version 10.0.2.
    README.txt file updated to README.md after applying this MR but got a warning.

    Adding screenshots for reference.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Manoj Raj.R Chennai

    What is the warning?

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Bushra Shaikh

    @Manoj Raj.R, please refer to the screenshot.

    Thanks!

  • Status changed to Needs work 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the patch is not cleanly applied.

    1.diff.txt:9: trailing whitespace.
    Dark Awesome Theme is Mobile-friendly Drupal 8,9 Responsive theme.This theme
    1.diff.txt:10: trailing whitespace.
    features a custom slider, Responsive layout and Highly Customizable.It also
    1.diff.txt:11: trailing whitespace.
    support Google fonts,font-awesome,and it is very good for any kind of Drupal
    1.diff.txt:46: trailing whitespace.
    This theme requires no modules outside of Drupal core.
    1.diff.txt:69: trailing whitespace.
    
    warning: 5 lines add whitespace errors.
    
    
    
    2. The file does not follow the readme.md file instructions. Please refer: https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia mohd sahzad

    Mohd Sahzad โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 9 months ago
  • Status changed to Needs work 9 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the file still has some issues:

    1. 1.diff.txt:9: trailing whitespace.
    Dark Awesome Theme is Mobile-friendly Drupal 8,9 Responsive theme.This theme
    1.diff.txt:10: trailing whitespace.
    features a custom slider, Responsive layout and Highly Customizable.It also
    1.diff.txt:11: trailing whitespace.
    support Google fonts,font-awesome,and it is very good for any kind of Drupal
    1.diff.txt:46: trailing whitespace.
    This theme requires no modules outside of Drupal core.
    1.diff.txt:69: trailing whitespace.
    
    warning: 5 lines add whitespace errors.
    
    
  • Status changed to Needs review 9 months ago
  • Status changed to Needs work 9 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Still getting the same error.
    1.diff.txt:9: trailing whitespace.
    Dark Awesome Theme is Mobile-friendly Drupal 8,9 Responsive theme.This theme
    1.diff.txt:10: trailing whitespace.
    features a custom slider, Responsive layout and Highly Customizable.It also
    1.diff.txt:11: trailing whitespace.
    support Google fonts,font-awesome,and it is very good for any kind of Drupal
    1.diff.txt:14: trailing whitespace.
    Stable, Font Awesome and dark-awesome js etc. For a full description of the
    1.diff.txt:16: trailing whitespace.
    Submit bug reports and feature suggestions, or track changes in
    warning: squelched 2 whitespace errors
    warning: 7 lines add whitespace errors.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia gajanan.wasnik

    gajanan.wasnik โ†’ made their first commit to this issueโ€™s fork.

  • Assigned to gajanan.wasnik
  • Status changed to Needs review 9 months ago
  • Status changed to Needs work 4 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi gajanan.wasnik

    I reviewed the MR!1 the Project page and Issue queue is missing spacing.
    It should be

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

    Thanks.

Production build 0.71.5 2024