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

Add documentation for information available in workflow extensions #208

Closed
yangbobo2021 opened this issue Jan 24, 2024 · 0 comments · May be fixed by devchat-ai/workflows#54
Closed

Add documentation for information available in workflow extensions #208

yangbobo2021 opened this issue Jan 24, 2024 · 0 comments · May be fixed by devchat-ai/workflows#54
Assignees
Labels
P1 Important but not that urgent

Comments

@yangbobo2021
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 Important but not that urgent
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant