Adding jsDoc to code and generating documentation

[rageycomma]

I have a few projects that use this framework so, I have a bit of a vested interest in doing a bit of maintenance on the code. I think to make it a more successful open source endeavour, we should put JsDoc on the code and generate documentation. This way it'd be easier for new developers to get to grips with the code as I've noticed there are very few comments in there and no real documentation on the design decisions of the CLI, which would be nice to get a start on.

My suggestion is:

1. Add JsDoc comments on classes, functions and properties and minimal but useful comments that would help developers understand what code is doing, particularly around hooks, etc.
2. Add tooling into package.json to generate out JsDoc/HTML files (Example theme: https://github.com/nhn/tui.jsdoc-template?tab=readme-ov-file)
3. Add lint rules to ensure JsDoc comments if present, are accurate (but don't enforce that they are present, otherwise we have to document the entire repo at once lol)
4. Add GitHub Actions to publish docs generated as a GitHub page when PR is merged.

Happy to do said PR but obviously I don't want to do things if they're not going to be merged in :)

[mnapoli]

Hi! I'm fine merging local additions of jsdoc 👍 (especially in cryptic parts)

I don't think it makes sense to add huge changes to the project, just to be clear on the scope (i.e. adding jsdoc everywhere wouldn't be useful I think, the project is maintained but no huge refactors are envisioned). Not looking to host the HTML documentation either, I never found it useful to go through a different website to understand the codebase, but feel free to generate and host that doc site on your own 👍

[rageycomma]

Yeah that's fine, I don't wanna document it all manually for sure just outline bits so it's easier to understand what's going on. I don't want to do any major refactors as well, just add a few bits and pieces to make my life easier :)

[mnapoli]

👍 makes sense