Improve the documentation's readability #299

New Issue

Closed

opened 2022-05-06 08:32:54 +00:00 by adrien · 1 comment

adrien commented

2022-05-06 08:32:54 +00:00

Owner

This issue inventories graphical "bugs" in the documentation, that hurt its lisiblity. Please add comments with checkboxes to list pain points you identified.

When overflowing tables are involved

Taking the S3 Compatibility page as an example, we see that the documentation layout sometime hinders reading the content:

On small screens (e.g. smartphone), the overflowing tables cannot be read. The viewport should be adapted to the size of the biggest table.
On medium-large screens (1600px on mine), the "Page content" aside covers the tables. This aside could be foldable.

This issue inventories graphical "bugs" in the documentation, that hurt its lisiblity. Please add comments with checkboxes to list pain points you identified. ### When overflowing tables are involved Taking the [S3 Compatibility page](https://garagehq.deuxfleurs.fr/documentation/reference-manual/s3-compatibility/) as an example, we see that the documentation layout sometime hinders reading the content: * [ ] On small screens (e.g. smartphone), the overflowing tables cannot be read. The viewport should be adapted to the size of the biggest table. * [ ] On medium-large screens (1600px on mine), the "Page content" aside covers the tables. This aside could be foldable.