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

Autogenerate low-code reference docs for all components #17398

Closed
girarda opened this issue Sep 29, 2022 · 1 comment
Closed

Autogenerate low-code reference docs for all components #17398

girarda opened this issue Sep 29, 2022 · 1 comment

Comments

@girarda
Copy link
Contributor

girarda commented Sep 29, 2022

Problem

As a user writing or using YAML, I want to comprehensively see all the components I can use and the documentation of their parameters.

Proposed Solution

#21231 added a link to that docs

But it would be a better experience to have a CI hook which embeds this into the docs directly, using something like https://coveooss.github.io/json-schema-for-humans -- whatever we use should be easy to navigate and should feel like. using a javadoc or an autogenerated sphinx reference doc.

@girarda girarda self-assigned this Sep 29, 2022
@girarda girarda closed this as completed Oct 5, 2022
@girarda girarda reopened this Oct 6, 2022
@girarda girarda changed the title Add YAML schema definition for all low-code components to docs Autogenerate low-code reference docs for all components Dec 22, 2022
@girarda
Copy link
Contributor Author

girarda commented Apr 27, 2023

closing because the manifest docs is generated

@girarda girarda closed this as completed Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant