Skip to content

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

@smoy

Description

@smoy

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions