nus-cs2103-AY2425S1 / forum

12 stars 0 forks source link

I am unable to find the issue in my GitHub readme of markdown syntax present but it is seen in the other link. #394

Closed miuna9890 closed 3 hours ago

miuna9890 commented 5 hours ago

https://github.com/miuna9890/ip/blob/master/docs/README.md

Just to let you know, the following problems were noted with respect to your iP final submission:

An automatic check found that your iP user guide (as shown here) might not be rendered correctly e.g., markdown syntax such as ##, --|-- or HTML tags such as
are visible in the page. Please check the page carefully to confirm it shows what it supposed to. If no problem found, you can ignore this email. If you located a problem, please fix soon (no penalty).

JoanneHing commented 4 hours ago

I think the problem that the ## Guide is having an extra whitespace before the ## as shown below (highlighted part). By removing it should render the markdown correctly.

Screenshot 2024-09-21 at 2 08 57 PM

Some Suggestions

Besides here are some suggestion for the GFMD for your UG

  1. Format can be shown in inline code Screenshot 2024-09-21 at 2 11 10 PM

  1. Consider using $_num$ for the subscript Screenshot 2024-09-21 at 2 12 32 PM

  1. Consider setting first characters of word in headings as capital letters Screenshot 2024-09-21 at 2 15 30 PM

  1. Bold the first line or important keywords of the paragraph instead of the whole paragraph Screenshot 2024-09-21 at 2 15 53 PM

Just some minor suggestions that you can consider! Its very nice of you include the sample GUI for each of the features outcome too! Good job! Hope it helps!

miuna9890 commented 3 hours ago

Thanks alottt @JoanneHing ! I will implement the suggestions too. thx

JoanneHing commented 2 hours ago

Welcome!