Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Add API documentation #449

Open
EandrewJones opened this issue May 7, 2024 · 2 comments
Open

chore(docs): Add API documentation #449

EandrewJones opened this issue May 7, 2024 · 2 comments
Labels
Documentation Instructional Material and Reference Good First Issue Stuff for folks new to project help wanted Investigation

Comments

@EandrewJones
Copy link
Contributor

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).

@EandrewJones EandrewJones added help wanted Documentation Instructional Material and Reference Good First Issue Stuff for folks new to project Investigation labels May 7, 2024
@kanz-1805
Copy link

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
Copy link
Contributor Author

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Instructional Material and Reference Good First Issue Stuff for folks new to project help wanted Investigation
Projects
None yet
Development

No branches or pull requests

2 participants