martinng01 / pe

0 stars 0 forks source link

Setting up and getting started link in DG is broken #8

Open martinng01 opened 3 months ago

martinng01 commented 3 months ago

The Setting up and Getting Started link just brings me to the same page.

Screenshot 2024-04-19 at 5.29.10 PM.png

nus-se-bot commented 3 months ago

Team's Response

We flag this as duplicate as both refer to the same hyperlink in DG.

The 'Original' Bug

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

"Setting up and getting started" link directs to same section

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.


In the Developer Guide, the "Setting up and getting started" hyperlink under the "Setting up, getting started" heading does not link to any external resource, and links back to the same heading 1 line above it. Without the proper link, developers can not setup the application.

Hovering on the hyperlink shows the underlying link redirects to page 2 (the same page):

image.png


[original: nus-cs2103-AY2324S2/pe-interim#4357] [original labels: type.DocumentationBug severity.High]

Their Response to the 'Original' Bug

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

It should have been linked to our user guide. However, we believe it is not high severity. Users are able to navigate to the user guide easily where , this setting up guide has been robustly documented so users/readers just need to take reference from there. This only causes a slight inconvenience to readers/users and does not affect the usability of our product.

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: [replace this with your explanation]