AdityaB4 / pe

0 stars 0 forks source link

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

Open AdityaB4 opened 7 months ago

AdityaB4 commented 7 months ago

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

soc-se-bot commented 7 months ago

Team's Response

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 severity

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

Reason for disagreement: I would disagree that this is a Low severity bug since it may not be immediately obvious to refer to the user guide. Moreover, this is something that would affect most (if not all) readers, and manually opening the user guide would serve as a non-obvious workaround since the link does not mention that it intends to take you to the user guide and the reader does not have any cues that would make them open the user guide. As such, I believe this fits in between the descriptions of a Medium and High severity bug:

image.png

So, it would make sense to label this as a Medium severity bug instead (preferring the lower severity option between Medium and High).