nus-se-bot
commented
1 year ago Team's Response
We have links in our TOC in UG and DG, and wherever we deem necessary we provided links to different content that are relevant to the reader at that point. Too many links may make the UG and DG visually unappealing.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: I disagree with the team's premise that the addition of links would render the documentation visually unappealing. This links can simply be embedded in part of the main text itself, and does not necessarily affect anything from a visual standpoint. Even the example of the "Back to top" link given in my original issue report would not only be a welcomed addition to the documentation, but also aid in redirecting readers back up to the TOC that your team has mentioned in your response. As of now the TOC is the only convenient method of navigating through the doc, and manual effort would be required to get back up to the TOC whenever the reader wants to jump to a different section.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Given below are the definitions for severities of VeryLow, Low, and Medium.  This cannot be of severity.VeryLow as this is clearly more than an issue of cosmetics. This falls upon genuine inconvenience to the reader when reading your documents. As it would affect almost everyone that reads it, we cannot argue that the occurrence of this inconvenience is *very rare*. Since documentation is still usable, i.e., readable, this lands a severity of Medium.
There are little to no links provided in the UG and DG (for instance, a "back to top" link to go back to the top of the document) to aid in navigation. This will cause inconvenience to the every reader as they will need to scroll quite a bit, but the documentation itself is still usable, hence landing it the medium severity.