apache / flagon-useralejs

Apache Flagon UserALE is a comprehensive, thin-client behavioral logging tool
https://flagon.apache.org/
Apache License 2.0
26 stars 26 forks source link

chore(docs): Add API documentation #449

Open EandrewJones opened 6 months ago

EandrewJones commented 6 months ago

Problem

We need maintainable documentation of our library's API, at minimum

Solution

Use TypeDoc or sphinx-js autodoc. TypeDoc is likely better since we're migrating to TS (#442).

kanz-1805 commented 6 months ago

Hi @EandrewJones I was looking into the API documentation requirement. If it is REST API, I'd love to help you with the documentation. Thanks!

EandrewJones commented 5 months ago

@kanz-1805 UserALE is not a REST API. It is a javasript library used on the client-side (browser) of web applications to help track user behavior.

We need to auto-generate documentation for all of the functions (collectively, the API) so that we can publicly share it via something like ReadTheDocs. The process will be very similar to how you would generate documentation for a REST API, but slightly different in terms of the tooling you would use. For instance, we will probably use TypeDoc since we already have docstrings for most of our functions and are in the middle of migrating to typescript.

Is there a particular reason why you are only interested in a REST API?