search

modembcc / pe

0 stars 0 forks source link

Duplicate TOC causing confusion #2

Open modembcc opened 3 months ago

modembcc commented 3 months ago

Issue: There is another TOC right below the TOC section of the User Guide. This can cause confusion as to the number of sections in the User Guide and the number of commands.

Steps to Reproduce:

  1. Refer to the user guide
  2. Navigate to TOC
  3. Another TOC can be spotted right under.

Expected Result: The documentation accurately has a single functional Table of Contents.

Actual Result: The documentation misleads users by having duplicate TOC.

Screenshot: image.png

soc-se-bot commented 3 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

PDF version of UG has duplicate table of contents

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.

image.png

[original: nus-cs2103-AY2324S2/pe-interim#4085] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

This is a purely cosmetic flaw that does not affect the user's reading of the UG. Both tables of content work, so users can use either to navigate the UG. Our team sees no issues with this duplicate table of contents.

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