LargeCrowd / pe

0 stars 0 forks source link

UG has a lot of unnatural/unnecessary page breaks and spacings #4

Open LargeCrowd opened 4 months ago

LargeCrowd commented 4 months ago

The huge page breaks makes it not very pleasant to navigate the UG, as there is a lot of scrolling required to go from one command to the next. Some of the info could easily be merged onto the same page (especially those with less than half a page of content), to save on page space and scrolling.

Given this format where you put each command on a new page, you could also include a hyperlink to jump back to the table of contents for ease of navigation

image.png

image.png

image.png

image.png

image.png

image.png

nus-se-bot commented 4 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]

Heading in DG not ideal formatting

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 heading for Design Architecture is on the last lines of the previous page. A page break would be more appropriate here


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

Their Response to the 'Original' Bug

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

The page break and extra white space is introduced by the PDF conversion and is not counted as bugs (given that no diagrams were being split between pages): Screenshot 2024-04-22 at 3.13.56 PM.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: I dont believe its the same issue, as rather than having strange formatting of header as in #5179, it is the issue of having too much whitespace, hindering usage of the UG. Similar, but not the same. However, it does seem to be a formatting issue caused by pdf conversion


## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]