search

jamieeeleow / pe

0 stars 0 forks source link

Formatting of PDF version of User Guide #10

Open jamieeeleow opened 1 year ago

jamieeeleow commented 1 year ago

As the user guides are in pages, unlike a website that just flows, it will be neater if each segment is properly documented within a page instead of having cut outs that are on the next page.

For instance in the the image shown below

image.png

The top of the page started with a broken continuation from the previous page that looked like this

image.png

Hence by putting them together when formatting will make it look a lot neater and easier to understand.

Some other examples are when the header is being separated from the body of content as shown below:

image.png

The attributes header is being separated from the content on an entirely different page.

nus-pe-script commented 1 year ago

Team's Response

This is a duplicate of "#3451: Formatting of the PDF version of the Developer Guide" because both talk about page breaks in the documentation. They can be resolved in the same PR.

Also, since this is a cosmetic issue, it should be VeryLow in severity.

The 'Original' Bug

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

Formatting of the PDF version of the Developer Guide

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.

Just as with the User Guide, the DG can be improved on its PDF formatting.

An example would be that a table is being split into two pages when it can fit into one page. This can improve the readability for users.

image.png

Instead of having them on two pages, if its on one page it has a better flow and continuation.

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

Their Response to the 'Original' Bug

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

Cosmetic issue. Hence, severity should be Very Low.

We do not need to care about PDF conversions unless it hinders the reader.

telegram-cloud-document-5-6186094477929613727.jpg

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]

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Same reasoning as the duplicate of the issue
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]