Douglch/pe

Broken link in UG documentation

Opened this issue · 1 comments

image.png

The link provided in the line above is: https://ay2223s2-cs2103-f10-1.github.io/tp/(#12-prefixes-used-in-commands), which brings me to a Github page with 404 error.

Steps to replicate:

  1. Go to the section "3. Features", 2nd last bullet point

Reason:
Users may not know where [Prefix and Parameters] are located, and thus not know the specific constraints of each parameter which can be important to note for a suer.

Team's Response

No details provided by team.

The 'Original' Bug

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

Hyperlink does not work

UG hyper link [Prefix and parameters] does not work, unable to go to prefix section.

Screenshot 2023-04-14 at 2.49.36 PM.png


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

Their Response to the 'Original' Bug

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

Screenshot 2023-04-16 at 11.01.16 AM.png

According to the instructions provided on documentation bugs on the PE website, a broken link should only warrant a Low or Medium severity. There is also no justification by the tester on why it deserves a high severity.
Our team accepts the bug, albeit at a low severity, as the Prefixes and Parameter section comes BEFORE the Feature section and readers who have read our UG in order should have already read through the Prefixes and Parameter section. The hyperlink only serves as a convenience tool, should the user forget any important information. Moreover, as the sections are clearly labelled, users can easily scroll to the desired section or even to the TOC, which would redirect them to the desired Prefix and Parameter section.

Items for the Tester to Verify

❓ Issue duplicate status

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

  • I disagree

Reason for disagreement: [replace this with your explanation]


❓ Issue severity

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

  • I disagree

Reason for disagreement: [replace this with your explanation]