This repository was archived by the owner on Feb 19, 2025. It is now read-only.
Repository navigation
This repository was archived by the owner on Feb 19, 2025. It is now read-only.
chore(docs): Add API documentation #449
Description
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).
Activity
kanz-1805 commentedon May 12, 2024
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 commentedon May 14, 2024
@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?