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

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:

Comments

nitapawar created an issue. See original summary.

anybody’s picture

Assigned: nitapawar » Unassigned
Status: Needs review » Needs work

@nitapawar you didn't provide a MR yet!

anybody’s picture

Version: 8.x-1.2 » 2.x-dev
rohitsharma401’s picture

Assigned: Unassigned » rohitsharma401
Status: Needs work » Needs review
StatusFileSize
new1.5 KB

Patch for Changing README.txt to README.md as per markdown syntax.

rohitsharma401’s picture

Assigned: rohitsharma401 » Unassigned
paraderojether’s picture

Status: Needs review » Needs work
StatusFileSize
new48.36 KB

Hi @ rohitsharma401

I reviewed patch #4 and it fails to apply for me, Theme Switcher Rules version 2.x-dev, Drupal Core version 9.4.7, PHP version 8.1.8. Another concern, please also follow the new template: https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Please check.
Thank You.

rohitsharma401’s picture

Assigned: Unassigned » rohitsharma401
Status: Needs work » Needs review
StatusFileSize
new3.07 KB

Here is the patch with Proper markdown and Sentence-case with Drupal Guidelines .

rohitsharma401’s picture

Assigned: rohitsharma401 » Unassigned

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

nayana_mvr’s picture

Verified the patch #7. There were some format issues. Corrected them and created an MR for this ticket with all the changes. Please review.
Thanks.

hardikpandya’s picture

Assigned: Unassigned » hardikpandya
Status: Needs review » Needs work

The MR is currently not mergeable and would need a rebase.

hardikpandya’s picture

Assigned: hardikpandya » Unassigned
Status: Needs work » Needs review

Rebased and added hyperlinks to the table of content items.

paraderojether’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new249.83 KB
new292.03 KB

Hi @ nayana_mvr and hardikpandya

I reviewed the MR and your changes, and this looks good to me.

Moving this to RTBC.
Thank You.

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

thakurnishant_06’s picture

Status: Reviewed & tested by the community » Needs work
liam morland’s picture

@#16: What work is needed?