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
#17 3322421 - after.png197.7 KBkenyoowen
#17 3322421 - before.png203.69 KBkenyoowen
#15 tabtamer.png125.26 KBnupur badola

Issue fork tabtamer-3322421

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

Raghavendra A M created an issue. See original summary.

Raghavendra A M opened merge request !2

raghavendra a m’s picture

raghavendra a m commented
Status: Active » Needs review

Committed according to the proposed solution.

Please review it.

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

Pracheth’s picture

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

Reviewed the README.md (latest MR! by Raghavendra A M #2), which needed minor work on markdown formatting and also added maintainers section.
Committed the changes to the issue fork, Now the Markdown looks good to me(https://git.drupalcode.org/issue/tabtamer-3322421/-/blob/3322421-replace...), Adhering to Drupal markdown practices.

Changing status to Reviewed and Tested by Community.

Manoj Raj.R made their first commit to this issue’s fork.

Manoj Raj.R’s picture

Manoj Raj.R commented

Its good to have Module name on top of Readme file.

Made some minor updates which are respect to the markdown format.

Other than everything looks good to me.

Good to be in RTBC

lamp5’s picture

lamp5
Primary language Polish
Location Rzeszow
commented

You have to update hook_help...

lamp5’s picture

lamp5
Primary language Polish
Location Rzeszow
commented
Version: 2.0.0-beta2 » 2.x-dev
Status: Reviewed & tested by the community » Needs work
Manoj Raj.R’s picture

Manoj Raj.R commented

Updated the hook_help.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs work » Needs review
nupur badola’s picture

nupur badola commented

There is some issue with the patch.

## Installation And Usage
warning: 1 line adds whitespace errors.
Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs review » Needs work
Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs work » Needs review

Updated.

Please review.

nupur badola’s picture

nupur badola commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new tabtamer.png125.26 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 3322421 - before.png203.69 KB
new 3322421 - after.png197.7 KB

Hi Manoj Raj.R

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

Thank you.

lamp5’s picture

lamp5
Primary language Polish
Location Rzeszow
commented
Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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