search

microsoft / durabletask-java

Java SDK for Durable Functions and the Durable Task Framework
MIT License
13 stars 7 forks source link

API reference docs (JavaDocs) to docs.microsoft.com #71

Closed cgillum closed 1 year ago

cgillum commented 2 years ago

We currently have Azure Functions-specific API documentation here: https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.functions?view=azure-java-stable. We should create similar auto-generated documentation for our two maven packages: durabletask.client and durabletask-azure-functions.

I believe there is a standard process for this that also takes care of auto-updating docs as we release new versions of our maven packages.

cgillum commented 1 year ago

Note that Jonathan Giles is helping us with this.

Ideally the durabletask-client package's reference documentation would be under a "Microsoft Durable Task Client" section since we want to use this package both for Functions and for non-Functions scenarios (for example, Dapr). The durabletask-azure-functions package, however, should be part of the existing Azure Functions SDK for Java.