search

nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

UG is not well formatted, making it hard to understand #208

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

The table of content had specifically differentiated the two states, Main State and Task State. However, when browsing the UG, it has been difficult to differentiate the commands belong to which of the two states due to similar font sizes, despite slight differences in the font type as seen below.

image.png

The team can craft their headings with different sizes instead so users can easily find the sections when scrolling.

[original: nus-cs2113-AY2425S1/pe-interim#363] [original labels: type.DocumentationBug severity.VeryLow]

AjayShanker-geek commented 1 week ago

Team's Response

Thank you for your feedback. We appreciate you highlighting this issue on our Developer Guide. We will review the formatting to ensure the headers are more clearly associated with their respective states in future updates.

Duplicate status (if any):

--