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

Generate docs for config schema #2637

Closed
mattiekat opened this issue Aug 10, 2023 · 0 comments
Closed

Generate docs for config schema #2637

mattiekat opened this issue Aug 10, 2023 · 0 comments
Labels
agent docs Improvements or additions to documentation permissionless permissionless deployments PI

Comments

@mattiekat
Copy link
Contributor

mattiekat commented Aug 10, 2023

During our 1:1 today, @tkporter and I talked about the new config format and possible ways to document it. Ultimately it would be nice to have some sort of markdown config that we can point people at if not even a config that is automatically inserted into our gitdocs. A first step to either of those is to have some sort of markdown-from-schema conversion.

A solution that I can see after very little searching would be to use zod-to-json-schema and then jsonschema2md.

There's also a typedoc-plugin-zod that might work.

The problem this answers is:
As a hyperlane operator, I want to have an easy reference of what the current configuration shape looks like.

Relates to #2215

@mattiekat mattiekat added docs Improvements or additions to documentation enhancement agent permissionless permissionless deployments PI labels Aug 10, 2023
@nambrot nambrot closed this as completed Feb 29, 2024
@avious00 avious00 closed this as not planned Won't fix, can't repro, duplicate, stale Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent docs Improvements or additions to documentation permissionless permissionless deployments PI
Projects
Archived in project
Development

No branches or pull requests

3 participants