search

seanngja / pe

0 stars 0 forks source link

Label in table of content and header in UG not matching #10

Open seanngja opened 3 days ago

seanngja commented 3 days ago

For example: In table of contents, ViewQuota Command leads to the header View remaining quota: viewQuota

nus-pe-bot commented 11 hours ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Thanks for mentioning this.

However, we believe that the header in ToC should be shorter, so that the user can quickly find the information they want. While the content header means to provide richer details about the commands. Therefore it's not necessary that the header in ToC matches the exact content header.

The 'Original' Bug

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

Hyperlinks in table of contents in UG are not accurate

For example, selecting Pre-Usage Guidelines directs me to the Language Recognition component. So the hyperlink are not effective as user still needs to scroll up to view all the related information.

{28E5C999-271D-4839-BD82-B7E9E0B1FD8D}.png

The output:

{4E6A4DC7-7EC0-452D-87EF-77528A0EDE95}.png

Similarly, for example, view quota hyperlink brings me to allocate

[original: nus-cs2113-AY2425S1/pe-interim#165] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thanks for raising this issue. Our team is rejecting this issue. To be more concrete, we took a look at the code for the UG and verified that the links for the mentioned Table of Contents is indeed correct. The code has not been altered since the release of v2.1. If it is a page break issue, our team believes that this issue does not hinder the reader and it need not be optimized as mentioned in the course website.

image.png

image.png

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 reason]

## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your reason]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your reason]