search

AdityaB4 / pe

0 stars 0 forks source link

Multiple numbered lists are shown on the same level in TOC #13

Open AdityaB4 opened 7 months ago

AdityaB4 commented 7 months ago

Multiple independent numbered lists are shown on the same level of indentation and in the same sub-block in the developer guide table of contents.

image.png

This can cause the user confusion since it may seem like numbers go up to 5 and then reset to 1 without explanation.

soc-pe-bot commented 7 months ago

Team's Response

Even though this might be a valid bug. We feel that we should not be penalised for this as it should not confuse the reader at all as the number clearly differentiates the points. :D Thanks for your suggestion!

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I believe this should be in scope for the project since the effort needed to provide user-value here is very low. Simply indenting a few lines significantly reduces any cognitive load on a reader and provides proper navigability of the documentation.

Considering this is the central page from where the documentation is navigated, and linked back to at times, I think the lack (or low level of) clarity in differentiation here is an important bug to resolve and should be prioritised as in scope.