Closed (fixed)
Project:
Link
Version:
7.x-1.x-dev
Component:
Documentation
Priority:
Minor
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
18 Oct 2022 at 08:23 UTC
Updated:
27 Mar 2025 at 11:09 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #3
damienmckennaPlease rework the existing content using Markdown syntax rather than replacing it.
Comment #4
Manoj Raj.R commented@damienmckenna
Ok Checking on it
Comment #6
Manoj Raj.R commentedComment #7
dineshreddymathuku commentedHi #3 and #4 thanks for your Responce
#5 patch is looks good for me so
changing the status RTBC
Comment #8
damienmckennaSorry folks, but there needs to be more work on this beyond renaming the file.
You've both opened and worked on a lot of issues like this for different projects, please put a little more work into them beyond just renaming a file, a plain text file renamed to ".md" is wasted time.
Comment #9
Manoj Raj.R commentedWill check it.
But when we are renaming the Readme file to .md format it automatically detects the Markdown format and adapts according to that.
So we are adding it and verifying in the
Can you please mention which way it can be improved instead of Renaming in the file.
Comment #10
Manoj Raj.R commented@damienmckenna
Can you please check now.
Have used the format as from the https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
Here is a summary of the preferred format for README.md:
Headings in all caps.
Headings underlined with ===/--- to the length of the heading, followed by a blank line.
Two lines prior to headings (except the first one).
Bullets denoted by asterisks (*) with hanging indents.
Numbered lists indented 4 spaces.
Bulleted lists indented 1 space.
Text manually word-wrapped within around 80 cols.
Comment #11
damienmckennaThank you, that's better.
I'm going to review the document as a whole as there are some other changes I think we should make to make it work better as a Markdown file.
Comment #13
dineshreddymathuku commentedComment #15
damienmckennaCommitted. Thank you.
Comment #16
damienmckennaComment #17
damienmckenna