mystmd
mystmd copied to clipboard
misplaced documentation section on admonitions
in the doc the section on admonitions here https://mystmd.org/guide/embed#eh5oPdEP56 imho does not belong here (between include and embed...)
this section is kinda like a reference manual for the admonition directive
it should rather show up somewhere in here instead https://mystmd.org/guide/admonitions
Hey @parmentelat,
The admonition documentation is being brought in by the embed, i.e.  is pulling it in. You can see the original at https://mystmd.org/guide/directives#directive-admonition. Given that this is an intentional example, I think we can close this issue?
oh dude, I had totally failed to see that upon first reading !
I could suggest a few cosmetic tweaks that would make it less inconspicuous:
- I think what fooled me most is the fast that
admonitionappears in the right sidebar as a proper section in this doc - also rephrasing
(Embedding from the MyST Spec)into(Embedding the admonition section from the MyST Spec)would have helped understanding the purpose better
the second seems easy; not sure about the first; I can propose a PR if you agree on the general idea ? or just store it under the 'stupid me' category, that can work too :)