devchat-ai
Add documentation for information available in workflow extensions
Hello,
There seems to be a lack of documentation specifying what information can be obtained within the workflow extensions. For developers, not knowing which pieces of information and details they can access can become a significant hurdle in extending and using the workflow functionalities effectively.
To address this issue, I propose that we create more comprehensive documentation detailing the types of information accessible through the workflow extensions. Maintaining the sync of documentation can be challenging, and an automated solution would be beneficial. Therefore, integrating descriptive information into the API comments might be a viable approach. This way, users can utilize inline documentation when working with the API, making it more accessible and easier to keep up-to-date.
Could we consider improving the current documentation, possibly generating docs from the API annotations to ensure they are always in sync with the codebase?
Looking forward to the team's input on this.
Best regards.
