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.

Sign up for GitHub

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

Jump to bottom

Auto-generate configuration documentation #616

Open
mikabytes opened this issue Feb 4, 2024 · 0 comments
Open

Auto-generate configuration documentation #616

mikabytes opened this issue Feb 4, 2024 · 0 comments
Labels
enhancement

Comments

@mikabytes
Copy link
Collaborator

As of #612 we use JSON schema for validating the configuration using Ajv. I think it would be great if we also documented it there and used a tool for auto-generating the markdown.

I came across jsonschema2md which seems to be a good fit for this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mikabytes