Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chaining admonitions should be avoided #896

Open
FlorianJacta opened this issue Apr 2, 2024 · 1 comment
Open

Chaining admonitions should be avoided #896

FlorianJacta opened this issue Apr 2, 2024 · 1 comment
Labels
📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟩 Priority: Low Low priority and doesn't need to be rushed

Comments

@FlorianJacta
Copy link
Member

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.

@FlorianJacta FlorianJacta added 📈 Improvement Improvement of a feature. 📄 Documentation Internal or public documentation 🟩 Priority: Low Low priority and doesn't need to be rushed labels Apr 2, 2024
@jrobinAV
Copy link
Member

jrobinAV commented Apr 2, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟩 Priority: Low Low priority and doesn't need to be rushed
Projects
None yet
Development

No branches or pull requests

2 participants