search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Input formats at bottom of User Guide #3102

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.

I think that leaving the input formats at the bottom can be confusing for new users since they may read the user guide in a top down manner and see the add command first without knowing the correct format for each input.

While I understand that there is a hyperlink to input formats, I would prefer to put the input format at the top so that new users who read the user guide in a top-down manner can get a glimpse at the input format first and may have more familiarity with the add command.

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

fairyinabottle4 commented 3 years ago

Team's Response

Thank you for the suggestion. However, this is not a bug, so we will reject it. We will consider it for future iterations :)

Duplicate status (if any):

--