Chaining admonitions should be avoided #896
Labels
📄 Documentation
Internal or public documentation
📈 Improvement
Improvement of a feature.
🟩 Priority: Low
Low priority and doesn't need to be rushed
Description
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.
The text was updated successfully, but these errors were encountered: