macareonie / pe

0 stars 0 forks source link

Image links #8

Open macareonie opened 2 months ago

macareonie commented 2 months ago

Might be a nit.

For some reason, the images on documentation are clickable/hyperlinks that redirect you elsewhere

image.png

nus-pe-bot commented 2 months ago

Team's Response

We flag this as duplicate as both raise the issue of clicking the image on the documents and being redirected to unreachable site.

The 'Original' Bug

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

User guide images open invalid links upon clicking them

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.


Most images in the user guide contain a link behind them, which does not lead to a valid URL. This may inconvenience users as they may expect the link to lead to a valid website. A user could also accidentally click these images while scrolling, further inconveniencing the user.

Screenshot after accidentally clicking on image image.png


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

Their Response to the 'Original' Bug

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

This does not hinder the user at all. The picture still demonstrates the relevant information that the user needs.

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]


## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** With reference to the image below, while this issue does not necessarily seem like a major hindrance, I believe it still classifies as one due to the fact that it can slow down readers when reading the documentation. On top of the confusion from the invalid pages the image links redirect readers to, for readers that accidentally click on the image links, it will be even more confusing to them if they did not even expect the image to be a hyperlink, much less an invalid one. ![image.png](https://raw.githubusercontent.com/macareonie/pe/main/files/f2da25cf-fc08-45e6-928d-b49d9adde7d6.png)
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]