pkulchenko
[request] better plugin documentation
hi... currently in homepage there is a "documentation" link, that leads to a webpage with summarized general help (usage, configuration, plugins, etc.) (note "adding an interpreter" link is disabled)
the "plugin" section lacks proper documentation classes like plugins, interpreters, apis, specs, ide, editor or whatever involved (i.e. global variables, required variables, properties, methods, parameters, return values, etc) (either doxygen, readthedocs. github wiki or whatever)... they just have links to some actual code files, UNCOMMENTED and poorly styled (e.g. no blank lines between functions, etc)
(required variables: i broke the entire ide startup, i don't know what i did wrong, the backtrace was not detailed enough, had to rename my plugin file temporarily to start the ide again)
as a novice self-learner programmer i am, i found the plugin "documentation" as it is now VERY unclear, confusing and hard to understand... i would like to try to write a plugin, but the fact i can't find out how things work and progress despite my efforts is exhausting and frustrating
please improve documentation, at least with comments in code, that way luadoc (doxygen?) can be passed after
Are you referring to this page in the documentation: https://studio.zerobrane.com/doc-plugin? There are definitely things that can be better detailed in the documentation and you're free to contribute what you think may be helpful to new users. I can definitely answer specific questions and add more details to the documentation as needed, but at this moment don't have time to contribute to the general documentation improvements.
yes that page
... additionally in the general documentation page https://studio.zerobrane.com/documentation the bottom link "adding an interpreter" is broken, and in "doc-plugin" interpreter is just mentioned 2-3 times
we are trying to write a TIC-80 plugin together with @oblerion but is very hard without proper documentation... i am sure better documentation will bring more ZBS interest and development from more people, just like us
... additionally in the general documentation page https://studio.zerobrane.com/documentation the bottom link "adding an interpreter" is broken, and in "doc-plugin" interpreter is just mentioned 2-3 times
i will write doc about package plugin for this IDE, because i need it for my two game engine elyoko egba.
