search

RachelChua / pe

0 stars 0 forks source link

Lack of content page with hyper links to help navigate through user guide easily #9

Open RachelChua opened 1 year ago

RachelChua commented 1 year ago

No details provided by bug reporter.

soc-se-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Error in displaying table of contents in the DG

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.

Currently in the DG, there is a heading for table of contents, but the table of contents is not present below it.

image.png

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

Their Response to the 'Original' Bug

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

Accepted but we believe it should be severity very low as it is purely cosmetic.

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: This is not a duplicate as the bug shown. The bug shows there is no table of content for Developer Guide. My bug is about how there is no table of content in the User guide. This makes it inconvenient and not user friendly for users to navigate easily through the user guide. A user guide should have a table of content with hyper links to navigate to the sections so that the user can conveniently go to the section that they are looking for quickly. Also, a table of content is important to let people know what your whole user guide is about.