search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

More granular Tables of Contents #201

Open nus-se-bot opened 3 years ago

nus-se-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 current Tables of Contents may not be detailed enough for experienced users who just needs to know the specification of one command.

image.png

Consider putting subheadings in the tables of contents. This poses minor inconveniences to the aforementioned usecase, and therefore Low Severity.

[original: nus-cs2103-AY2021S1/pe-interim#181]

justintzuriel commented 3 years ago

Team's Response

Thank you for your report! This is intended. The UG should also be beginner-friendly and we believe showing the full table of contents might be jarring and confusing to first-time users. Keeping the list short also helps the reader get a general structure of the UG instead of having to see all the submenus at once.

Duplicate status (if any):

--