danielleloh / pe

0 stars 0 forks source link

no use of page breaks to appropriately separate content chunks in user guide. #7

Open danielleloh opened 4 months ago

danielleloh commented 4 months ago

steps to reproduce

example sections that have been split across pages:

expected

sections should not be split across pages as it can inconvenience readers.

actual

section who should belong on the same page is split across 2 pages.

screenshots

Screenshot 2024-04-19 at 5.11.22 PM.png

Screenshot 2024-04-19 at 5.11.40 PM.png

other comments

you may want to consider using <div style="page-break-after: always;"></div> in your user guides markdown file to manually add page breaks.

soc-se-bot commented 4 months ago

Team's Response

For the formatting of our UG and DG, our team has indeed used <div style="page-break-after: always;"></div>. However, we felt that it was only necessary to add the page breaks to separate actual sections (eg. to separate the Quick Start section from the Graphical User Interface GUI section), rather than having page breaks within the section. Without the page breaks, it is still generally quite easy to follow since there is only a slight gap separating the two lines, and users are still able to read both lines at one glance. As we feel that our current use of page breaks within sections itself is already sufficient, we will be rejecting this bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]