search

Chronoxy / pe

0 stars 0 forks source link

[DG] Incorrect Hyperlinks #13

Open Chronoxy opened 4 days ago

Chronoxy commented 4 days ago

Background

Navigating through your DG as a developer, trying to understand the different components.

Encountered Behaviour

When clicking into hyperlinks like Main, MainApp, Ui.java, and more, I was directed to AB3's directory.

image.png

image.png

image.png

Suggestion

Update all hyperlinks in DG

nus-pe-bot commented 14 hours ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

DG: Hyperlink under Model Component still redirects to addressbook-3 repository

image.png

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: While it is similar in some form, noting that hyperlink for Model Component is not updated, but as mentioned in my bug report, it is more than just 1.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Thank you for your response. While I agree with a `low` severity rating if only a few links were outdated, however this issue is more pervasive. Besides `Model` component, as mentioned in my bug report `Main`, `MainApp`, `Ui.java`, and more. The list goes on with `Main`, `MainApp`, `Ui.java`, `MainWindow`, `MainWindow.fxml`, `Logic.java`, `Model.java`, and `Storage.java` being incorrect. This cumulative impact of multiple broken links significantly hinders the usability of the DG, which firmly justifies a medium severity. It can get to a point where the reader may feel "Should I trust what the Developer Guide is telling me?". This aligns with the CS2103 guidelines, as the inconvenience here is not minor but recurring and disruptive. ![image.png](https://raw.githubusercontent.com/Chronoxy/pe/main/files/01ca6b43-9618-4da9-8b25-1759080aa9f1.png) Thank you.