What I think would help placing globals in the documentation are categories in the scrollbar, like here:
I believe defines are just lua globals in factorio's case.
What I also like about their docs, is that the navbar is very succinct, it lets you easilly scroll through the fuck-tone of types they have.
So here are my suggestions:
Reduce clutter in navbar by not showing methods under types, or making them collapsible. Removing some of the icons
Add categories to the navbar
Put globals in their own category
Now the way I am exposing global "modules" right now is using userdata modules, so for example Vec2, will have a Vec2Globals userdata which is exposed as say the global variable Vec2,
Ideally there should be a way to have the Vec2Globals module not be shown in the navbar at all, but only under the global entry for Vec2
I've been looking through other games' lua documentation, I think factorio has a great and simple one that's similar to tealr's:
https://lua-api.factorio.com/latest/defines.html#defines.command.compound.
What I think would help placing globals in the documentation are categories in the scrollbar, like here:
I believe defines are just lua globals in factorio's case.
What I also like about their docs, is that the navbar is very succinct, it lets you easilly scroll through the fuck-tone of types they have.
So here are my suggestions:
Now the way I am exposing global "modules" right now is using userdata modules, so for example
Vec2
, will have aVec2Globals
userdata which is exposed as say the global variableVec2
,Ideally there should be a way to have the
Vec2Globals
module not be shown in the navbar at all, but only under the global entry forVec2