search

nus-cs2103-AY2223S2 / forum

12 stars 0 forks source link

Bugs for UG / DG page breaks #382

Closed Infrix closed 1 year ago

Infrix commented 1 year ago

There is a bunch of bugs mentioning UG and DG page break.

image For instance, a bug report stating that our component section was disrupted by a page break.

image In another instance, a similar bug report stating that another section was disrupted by a page break.

We received around 5 of these bugs at different sections of our UG/DG.
I understand that this could be a little disruptive for readers, but in some cases it is quite unavoidable. Should these be accepted as a documentation bug or should they be considered notInScope?

If it is, should we be accepting all of them or just one of them?

damithc commented 1 year ago

@Infrix page breaks appearing in the middle of a paragraph is common and readers should be used to it already e.g.,

image

But a page break in the middle of some type of content (e.g., in the middle of a detailed diagram) can hinder the reader and should be avoided.

I understand that this could be a little disruptive for readers, but in some cases it is quite unavoidable. Should these be accepted as a documentation bug or should they be considered notInScope?

You can factor in my general comment above when deciding. Other are welcome to chime in with their opinions.

If it is, should we be accepting all of them or just one of them?

If you want to combine them, email me the exact number of distinct cases (i.e., ignoring the report of exact same case) you want to combine so that I can advise you on how to upgrade the severity to match.