vanGoghhh / pe

0 stars 0 forks source link

Awkward line breaks and formatting in DG/UG #6

Open vanGoghhh opened 3 years ago

vanGoghhh commented 3 years ago

Description: There are many pages on the UG/DG where the last few sentences of the page are cut off, possibly due to lack or wrong usage of line breaks in the respective markdowns of the UG/DG. This might hinder the reader when reading the documents, and some important information may be cut off.

nus-se-bot commented 3 years ago

Team's Response

This was an issue caused by pdf print from github pages. This was not a bug caused by us.

Please refer to nus-cs2103-AY2021S1/forum#434.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: There are multiple awkward page breaks in the UG/DG which led to some content being unreadable. This increases the difficulty in deciphering the text and thus hinders the reader when trying to understand the content of the UG/DG which makes this a documentation bug. Thus I feel that it is important to properly format the pdf so as to not hinder the reader. The SE education website provides a way on how to force page breaks on the document on how to convert md into PDF.

Screenshot 2020-11-20 083954.PNG.jpg


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]