NFDI4Microbiota / nfdi4microbiota-knowledge-base

The NFDI4Microbiota Knowledge Base
https://nfdi4microbiota.github.io/nfdi4microbiota-knowledge-base/
Creative Commons Attribution 4.0 International
24 stars 26 forks source link

improve metadata section through rephrasing, adding tips and notes, line b… #191

Open magelm opened 3 months ago

magelm commented 3 months ago

Hey, hope the visual and minor text edits help to improve readability.

magelm commented 3 months ago

Overall it is great thanks! It improves the readability! My Markdown sense is tingling with the different HTML tags around (especially the ), but I would say this is a minor revision.

Best

Hey, Thanks for pointing this out. I think I used a different markdown cheatsheet resource than the flavored github you mentioned . I think the one I used was the one shared at the knowledge base sprint and since they mention that

You can use two or more spaces (commonly referred to as “trailing whitespace”) for line breaks in nearly every Markdown application, but it’s controversial.

and sind HTML is supported by the knowledge base, I used "< br >" for line breaks .

I'm okay with using either option but REGARDLESS, I think we should add a best practice markdown link to the "how to contribute" section to avoid this issue/ confusion in the future. I'll ask in the github committee rocketchat to get a consenus.