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

(continuous integration) we want to auto generate schema docs #623

Open
smoy opened this issue Aug 29, 2023 · 0 comments
Open

(continuous integration) we want to auto generate schema docs #623

smoy opened this issue Aug 29, 2023 · 0 comments

Comments

@smoy
Copy link
Contributor

smoy commented Aug 29, 2023

Is your feature request related to a problem? Please describe.
When developer update models, the published schema docs should be auto updated based on the model changes.

Describe the solution you'd like
there is already a docs automation that published any docs change to the public website. https://docs.iambic.org.

that process use existing mdx files checked into the repository.

maybe we want a process that look for changes in schema generation, if so, it should automatically open a pull request. so we can review the sanity of the docs.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Community Engagement
Help us prioritize this request and express your support by adding a 👍 reaction to the original issue. This will assist both the community and the maintainers in addressing this request.

Please avoid leaving "+1" or "me too" comments as they create extra noise for issue followers and do not assist in prioritizing the request. If you are considering working on this issue or have already submitted a pull request, kindly leave a comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant