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

CommentFileSizeAuthor
#6 After Patch.png121.41 KBBushra Shaikh
#6 Before Patch.png121.23 KBBushra Shaikh

Issue fork scrollup-3335695

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

Sonal Gyanani created an issue. See original summary.

Sonal Gyanani opened merge request !4

Sonal Gyanani’s picture

Sonal Gyanani commented
Assigned: Sonal Gyanani » Unassigned
Status: Active » Needs review

Created MR for the issue.
Please review.
Thanks

renatog’s picture

renatog commented
Status: Needs review » Needs work

I think we can improve that with Table of contents (TOC). More info at: https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

renatog’s picture

renatog commented
Status: Needs work » Needs review

MR updated with the suggestion from #4: https://git.drupalcode.org/project/scrollup/-/merge_requests/4

Is ready to be merged

Bushra Shaikh’s picture

Bushra Shaikh commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Before Patch.png121.23 KB
new After Patch.png121.41 KB

I have successfully reviewed your merge request !4 for drupal version 10.0.2.
README.txt file updated to README.md after applying this patch.
Adding screenshots for the reference.

Can be moved to RTBC +1

  • VladimirAus committed 7f244cec on 3.0.x 
    Issue #3335695 by Sonal Gyanani, renatog, Bushra Shaikh: Replace README....
vladimiraus’s picture

vladimiraus
Primary language English
Location Brisbane 🇦🇺
commented
Status: Reviewed & tested by the community » Fixed

Done! Thank you! 🧁

Status: Fixed » Closed (fixed)

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