search

gbv / cocoda-sdk

SDK for Cocoda and coli-conc services
https://gbv.github.io/cocoda-sdk/
MIT License
5 stars 1 forks source link

Replace JSDoc as it is no longer maintained #46

Closed ShukantPal closed 1 year ago

ShukantPal commented 2 years ago

Hi folks, JSDoc is no longer being actively maintained and that's why I built a better, maintainable toolset called webdoc. webdoc has a more modern theme that's fully customizable! I would be down to helping you move your documentation to webdoc, the choice is up to you.

stefandesu commented 2 years ago

Thanks, I'll take a look at it. We definitely want to move away from JSDoc, so it might be a good option.

stefandesu commented 2 years ago

Hi @ShukantPal, I actually tried to use webdoc with this repo today and I'm getting a whole bunch of warnings and error messages when trying it with the default config described here.

Here's the output: webdoc-output.txt

I understand that we're probably not using valid JSDoc in all places, but other tools at least succeed to build a documentation. (For example, I also tried out documentation.js which succeeds without complaining.)

Also, I was hoping that a newer, maintained documentation tool will finally get rid of our npm audit alerts, but unfortunately, both webdoc and documentation.js introduce yet more warnings.

ShukantPal commented 2 years ago

@stefandesu Thanks for testing it out. Can you publish the branch so I can fix these problems?

I'll look into the audit warnings - I assume JSDoc would have them too at this point though.

stefandesu commented 2 years ago

Published it here: https://github.com/gbv/cocoda-sdk/tree/webdoc Thanks for looking into it!

Yeah, JSDoc (and the better-docs theme) also have several audit warnings. I guess a documentation generator is fairly complex and it's difficult to minimize the dependencies.