nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

UG Glossary link under "Purpose" goes to quick start rather than glossary. #4294

Open nus-pe-bot opened 4 months ago

nus-pe-bot commented 4 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.

Glossary link here goes to quick start rather than glossary.

Here is the place with the link:

Screenshot 2024-04-19 at 17.14.11.png

Here is where it links to: Screenshot 2024-04-19 at 17.14.24.png

This is unexpected bahaviour and confusing for the user.

_{[original: nus-cs2103-AY2324S2/pe-interim#3550] [original labels: severity.Low type.DocumentationBug]}

0-yibai commented 4 months ago

Team's Response

It actually redirects you to the glossary link in the Overview (TOC), where you need to click Glossary again to go to the actual glossary section.

It is perfectly understandable that you thought it redirects you to the quick start because these 2 lines are very close.

However, we agree that requiring two clicks here is unnecessarily inconvenient, so we accept this issue.

We suggest to classify this as very low severity as this is a low priority issue for v1.4.

Duplicate status (if any):

--