nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

[UG] Bullet Points not Included within Boxes #2623

Open nus-se-script opened 3 days ago

nus-se-script commented 3 days ago

The bullet points and list items in the User Guide (e.g. command parameters, example inputs, etc.) are not included in the colored boxes, which looks messy and affects the readability of the User Guide.

The bullet points can be included within the boxes if you leave a blank line before and after the <box> and </box> tags. For example:


<box type="tip">

**Parameters:**

1. `INDEX`: Must be a valid client index in the filtered list that is currently shown.
2. `NAME`: Must be alphanumeric, can include spaces.
...

</box>

Example list items not included in the box: image.png

Example bullet points not included in the box: image.png


[original: nus-cs2103-AY2425S1/pe-interim#3574] [original labels: type.DocumentationBug severity.High]

RezwanAhmed123 commented 3 days ago

Team's Response

Thanks for bringing this up. Our group feels this is a cosmetic preference and does not actually hinder the readability of the user guide.

Duplicate status (if any):

--