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

Documentation generator from JSON Schema #42

Open
jonssonchristian opened this issue Feb 13, 2024 · 0 comments
Open

Documentation generator from JSON Schema #42

jonssonchristian opened this issue Feb 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@jonssonchristian
Copy link
Collaborator

It would be useful to generate documentation pages with human-friendly views of the JSON Schema, including details of types, constraints, field descriptions and examples. There are some tools available for documentation generation mentioned here. The docusaurus-json-schema-plugin looks like an interesting option.

Does anyone have experience of implementing something similar? Can you recommend specific tools?
@jonssonchristian jonssonchristian added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Feb 13, 2024
@jonssonchristian jonssonchristian mentioned this issue Mar 5, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jonssonchristian