Documentation and respective framework

[arsdehnel]

Wondering if there has been any consideration around more of a framework for documentation rather than just readme files? I don't necessarily have a strong opinion on what tool might make sense, just wanted to see if there were any thoughts/plans/starters for it. To me a key to a successful tool is a good set of docs. I wouldn't suggest there would need to be everything documented in the framework right from the beginning but getting something setup so it's easy to add things as folks have time/desire would be nice.

[jdalrymple]

This would be awesome. I have put some thought into it, but haven't had the time to get it all setup. I'll try and document the plans asap

[arsdehnel]

Cool. I don’t have a ton of time but would be interested in maybe helping out with that.

[Marethyu1]

I would potentially be interested in this too!

[jdalrymple]

Started looking into this. Thinking about using somehting similar to mkdocs or hugo. Will try and post up an example soon!

https://themes.gohugo.io/theme/kube/

[jdalrymple]

@Sharma-Rajat

[jdalrymple]

Beautiful docs, https://node-postgres.com/

[pablobirukov]

Would you guys consider switching to typescript? If so, then I can help you to introduce it, add build step and annotate the codebase. That will somehow solve the problem of documentation. I believe most of the IDEs (WS and VS Code for sure) pick up type definitions and show autocomplete even in javascript project (I don't even mention type check for typescript projects).

If you are not interested in switching to typescript, I can try to come up with @types/node-gitlab package, but that way it's harder to update types as you make changes in the codebase itself

[pablobirukov]

Also, there is https://github.com/TypeStrong/typedoc which makes it possible to generate the documentation, once you have added annotations to your code

[jdalrymple]

Cool!!! I thought about it initially, but had some trouble getting all the config stuff setup. I would def be interesting in trying it out though!

[jdalrymple]

https://docusaurus.io

[jdalrymple]

https://docsify.js.org/#/

[diegoazh]

Hello!, I'm recomend Vuepress for the documentation.
I would like to contribute with this but I don't know if this is in development now.

[jdalrymple]

Hey @diegoazh !! I was originally leaning to one of the two above options, but honestly all of them look pretty solid. If you'd like to build some docs in vuepress that would be great! Any reason you recommend vuepress over others?

[diegoazh]

Hi @jdalrymple, I recomend this tool for many reasons. It's simple, fast, markdown files, custom themes, service workers, google analytics, multilanguage support and all the power of VueJs inside of it.
It is new, I know, but it is very simple to use and it has a very fast development.