Improve documentation by adding jsDoc compatible method documentations

[jankapunkt]

I found many functions lack of proper parameter descriptions, for example in server.js. Especially options are often completely undocumented.

[jankapunkt]

Also the README should add a "migrate from 3.x" guide, even if there are no breaking issues

[jankapunkt]

@HappyZombies @jorenvandeweyer I have fiddled around with RST but it's a real struggle 🙈

My proposal would be:

• use a markdown template and update all guides to markdown-based
• use jsDoc with jsDoc to markdown to auto-generate API docs
• use GitHub actions + GitHub pages to auto-publish documentation instead of readthedocs

What do you think?

[jorenvandeweyer]

I agree. I'd suggest using Vitepress! Simple to setup and markdown templates.

[jorenvandeweyer]

If you want I can set it up.

[jankapunkt]

@jorenvandeweyer sounds promising! We can try to work on this on a separate branch. Does it support jsDoc?

[jorenvandeweyer]

@jankapunkt No it does not support jsDoc, do we need it?

[jankapunkt]

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