search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

DG - Not so neat table of contents #4675

Open nus-pe-bot opened 6 months ago

nus-pe-bot commented 6 months 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.

image.png

The table of content could be fit into a single page.

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

ryanlimdx commented 6 months ago

Team's Response

A table of content is supposed to indicate the different sections. Each entry is then linked to the relevant section for easier navigation. The only way it can fit within a page given this requirement (to list the sections) is to reduce the font size, which is not feasible as otherwise it will not be standardised and not comfortable for viewing in pdf.

Duplicate status (if any):

--