search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Sections in UG not well formatted #1170

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

The table of contents in the user guide shows that each section is designated a numbering. However these numbering is not followed elsewhere in the user guide. As a reader, it was hard to keep track of which part of the user guide I was in. Hence the UG is not well-formatted and hard to follow.

image.png

image.png

[original: nus-cs2113-AY2021S2/pe-interim#1170] [original labels: severity.Low type.DocumentationBug]

leowxx commented 3 years ago

Team's Response

Indeed, the numbering for the header of each section is missing.

However, since you may click on the items in the table of contents to navigate to the according sections, we would like to lower the severity from Low to VeryLow.

Duplicate status (if any):

--