Adopt JSDoc for documenting our code

[RubenSmn]

trafficstars

Proposition

Adopt JSDoc for our code documentation.

Why

We're using a lot of custom components, it is not always clear what kind of props the component expect us to pass or what types the props need to be.

I think this could be a good alternative to something like TypeScript, where we would have to change the entire code base. Using JSDoc we can incrementally update our documentation of our custom components and utility functions. This way we can still get the benefits of auto completion and such.

---

Some hints:

• Please read our readme for more information/guide/tutorial.
• For design guidelines checkout our Figma design.
• Here is an engineering book in Greenstand.
• To know more about our organization, visit our website.
• If you want to join the slack community (some resources need the community member's permission), please leave your email address.

[RubenSmn]

@dadiorchen @khalatevarun what are you guys' opinions about this?

[dadiorchen]

I'm good with this, so this is a way we can use autocompletion without TS?

[elidakirigo]

hi, I'd like to contribute to the documentation of this project.

[khalatevarun]

Is there any particular reason to not adopt typescript in our codebase? @dadiorchen @RubenSmn

[dadiorchen]

@khalatevarun maybe we can consider typescript at the beginning of the app, but now I don't think it worth the effort to do a big refactor.

[RubenSmn]

I agree with Dadior, the refactor would a thing we would have to do in a single change. With JSDoc we can incrementally document our code.