wongkj12 / pe

0 stars 0 forks source link

Diagrams are cut between pages in UG #8

Open wongkj12 opened 4 months ago

wongkj12 commented 4 months ago

In pages 21-22 of the UG (describing the find command), there is a large gap between "Possible error that you might encounter:" and the following diagram:

image.png

This formatting looks a bit messy and might be harder to follow as readers have to jump between pages.

Similar issues with gaps between diagrams and text also happen in other areas of the UG, e.g. between pages 22-23, 25-26.

soc-pe-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]

[UG] Minor bleeding of guidance boxes

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.


Hello!

This is also not a big deal, but found that the breaking of the info boxes could be quite jarring for readability!

Here is one example from page 27: image.png

Page 35:

image.png

Page 39:

image.png

This is quite cosmetic, so not a big deal!

Great job! I enjoyed exploring your product and I thought the interface was nice and clean like a clinic :)


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

Their Response to the 'Original' Bug

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

No details provided by team.

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]