makspll
commented
7 months ago Hi ConnorBP, appreciate all the issues!
Yes this repo is in dire need of better docs, I would appreciate PR's in this direction, what might help is this github pages doc: https://github.com/makspll/bevy_mod_scripting_lua (deployed at https://makspll.github.io/bevy_mod_scripting_lua/latest/), you can see how the docs look like for the Bevy API provider. have a look at our CD which deploys on releases to there automatically and will give you a better idea of how it works.
The documentation generation example isn't remarkably clear about what exactly gets auto generated. Also it does not show any example of submodules.
A demonstration of some of the libraries capabilities would be most useful, without it I am trying to figure out how the library is designed by throwing shit at the wall and seeing what sticks. This is rather tiring.
There is also no demo of methods or fields + setters and getters.