nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Back-to-top hyperlink is disguised as the product logo #1789

Open nus-se-script opened 11 months ago

nus-se-script commented 11 months 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.


Design:

The back-to-top hyperlink is disguised as the product logo on the top-right of each page.

image.png

Problem:

Although intentional, this makes it misleading as initially, I did not know there is a back-to-top option and had to scroll all the way up. As I started using the guide for the commands through the table of contents, I did not read the part on how to use this guide, as shown in the image above, and did not know this feature, and other users may face a similar experience.


[original: nus-cs2103-AY2324S1/pe-interim#2565] [original labels: type.DocumentationBug severity.VeryLow]

yongning0310 commented 11 months ago

Team's Response

Thank you for your feedback regarding navigation. I believe that reading the 'Using This Guide' section is the most fundamental step before proceeding with the rest of the user guide. Therefore, it is unreasonable to claim that other users will be confused.

Duplicate status (if any):

--