EandrewJones commented on issue #449: URL: https://github.com/apache/flagon-useralejs/issues/449#issuecomment-2109184750
@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](https://about.readthedocs.com/?ref=readthedocs.org). 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](https://typedoc.org/example/) 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? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@flagon.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@flagon.apache.org For additional commands, e-mail: notifications-h...@flagon.apache.org
