It would be really great if there are more examples in the MTSL docs. I see that there are already some great ‘examples’ in the tests. However, most potential users won’t navigate to the tests. Also, if the goal is to replicate the Modelica Standard Library (MSL), they have multiple examples per domain (fluid, electrical, etc.). I would like to contribute some examples (copy from tests and MSL examples), but the docs would need to be configured to allow this. Any advice on how to do this would be much appreciated.
I know there is already the ‘tutorials’ section on the index of the docs, but it would not make sense to have too many here.
I agree, it would be great if ModelingToolkit would have more examples and tutorials in the docs in general, not just in the Standard Library.
The docs could have a lot more examples. Our plan is to get a lot of examples into the examples section, and then ultimately redesign the docs to give the examples a better display like Tutorials | Lux.jl Docs. But first we need to build the set of examples to display (and the docs restructure will probably wait for MTK v10 which should simplify a lot of the internals and delete half of the code, so the docs will simplify a lot giving more space for examples)
2 Likes
Are we referring to MTK docs or std lib docs? I was referring specifically to std lib docs.
Kind of both. The MTK standard lib docs are missing the examples section right now 
. Just needs work.
1 Like