Open jankapunkt opened 2 years ago
Also the README should add a "migrate from 3.x" guide, even if there are no breaking issues
@HappyZombies @jorenvandeweyer I have fiddled around with RST but it's a real struggle :see_no_evil:
My proposal would be:
What do you think?
I agree. I'd suggest using Vitepress! Simple to setup and markdown templates.
If you want I can set it up.
@jorenvandeweyer sounds promising! We can try to work on this on a separate branch. Does it support jsDoc?
@jankapunkt No it does not support jsDoc, do we need it?
I think we are good with the current docs for now but in the long run jsDoc is a good way for API docs as the functions are documented in place
I found many functions lack of proper parameter descriptions, for example in
server.js
. Especiallyoptions
are often completely undocumented.