search

YoYoCiti / pe

0 stars 0 forks source link

Incorrect Links in DG #8

Open YoYoCiti opened 2 years ago

YoYoCiti commented 2 years ago

Description: There are links in the DG that navigates to the AB3 repo instead of the product's repo. Examples are MainWindow, Ui.java, Model.java etc.

image.png

Considered high severity as broken links include classes which have been changed from that of AB3's. Readers are directed to the wrong product's repository and this is a major inconvenience that would affect most readers.

nus-pe-bot commented 2 years ago

Team's Response

It does not affect the usability of our product.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: Initially, I rated the bug severity.High and the team has changed it to severity.Low, but now I think it should be severity.Medium.

While it is true that it does not affect the usability of the product (thus, not severity.High), the broken links in the Developer's Guide would cause significant inconvenience to readers, who are likely seeking to understand the product's codebase and structure to perhaps develop the product further. Considering that all the links to the codebase are of the wrong product (AB3), this means that the reader has to constantly go to the actual product's repository (not found in DG itself) and manually navigate to the relevant code whenever he/she wishes to reference the codebase.