Hello,

This library seems very nice to use for add-on creation. I had a glance at some parts of the source code to get an idea of what is possible. Now I'm wondering if there's documentation somewhere and where it is. If it exists, it would be nice to link it in the Readme.

Hello,

There is no separate documentation, there are mostly just comments in the source and examples of how things are used in Hero Rotation.

Is it a planned thing? Even though I saw a few of the possibilities while quickly looking at the source code, I feel like it's not easy to get an overview of all the possibilities the library offers. This could handicap other coders as well in their process of selecting a library, some could just ignore it because of that. Maybe a quick overview of the main features on the Readme would already be enough for an onlooker to consider it, while the in-code comments should be enough for the early stage of its existence.

Hello, unfortunately generating doc from Lua code is not straightforward.
We are looking into changing our base code to TypeScript using TypeScriptToLua which should solve the issue since docgen is way easier to use with TS (+ it would be complete since we would have static type).
I'm closing the issue since unless someone open a PR with a Lua docgen this is not something we would do until a rewrite with TS.