search

Avaiga / taipy-doc

Holds the documentation set for Taipy, not including the code documentation obviously.
https://docs.taipy.io/
Apache License 2.0
12 stars 14 forks source link

Chaining admonitions should be avoided #896

Open FlorianJacta opened 5 months ago

FlorianJacta commented 5 months ago

Description

image

https://docs.taipy.io/en/develop/manuals/gui/viselements/#some-examples

Chaining admonitions like this should be avoided because it makes the content visually crowded and hard to focus on. Furthermore, admonition titles don’t render in the TOC, and, in this case, it would probably be good if it did for being able to navigate more quickly. Using subtitles and paragraphs instead of admonitions is usually the best way, except for interpolating one example, warning, note, or whatever, to bring some additional precision on a plain paragraph. In any case, admonitions shouldn’t represent much of the content.

This could be the case on many pages of the documents.

jrobinAV commented 5 months ago

If you can, do not hesitate to list the various pages we need to adress.