nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

DG table of contents not shown #2937

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

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.


Similar to the UG, the table of contents for DG is shown as {:toc} instead of an actual table of contents. Can cause significant inconvenience to readers as the navigability of the DG is severely hindered, especially as the DG is a very large file. Readers cannot easily proceed to the section of interest. New readers who are not familiar with the layout of the DG will have a hard time trying to understand the layout of the DG. Overall, not reader friendly.

Screenshot 2022-04-16 at 3.25.48 PM.png


[original: nus-cs2103-AY2122S2/pe-interim#2991] [original labels: severity.Medium type.DocumentationBug]

ianfromdover commented 2 years ago

Team's Response

We are marking this a duplicate of #2918, as both issues (missing ToC in UG, and in DG) are caused by the same Markdown parser misconfiguration; as a result, it is impossible to rectify one issue without rectifying the other.

This is also substantiated by the PE guidelines:

What bugs can be considered duplicates? [...] Only the following cases can be considered duplicates:
(a) The exact same bug reported multiple times.
(b) Multiple buggy behaviors that are actually caused by the same defect and cannot be fixed independently (i.e., fixing one fixes the others automatically).

Duplicate status (if any):

Duplicate of #2918