Generate the docs from the JSONSchema automatically

[KOLANICH]

https://github.com/adobe/jsonschema2md
https://github.com/cloudflare/json-schema-tools

[trivialfis]

I think there are many tools we can choose from https://json-schema.org/implementations.html, although not sure which is the right one. But I would like to avoid js. ;-)

[KOLANICH]

But I would like to avoid js. ;-)

👍 for avoiding JS and :+100: for avoiding npm ;)

[KOLANICH]

https://github.com/coveooss/json-schema-for-humans - a generator written in python

[trivialfis]

@KOLANICH Thanks for the reference. Played with it a little bit, the "version" field tricks it as items of array are all constants so type is implicitly defined.

[trivialfis]

Will fix it.

[trivialfis]

@KOLANICH @hcho3 I'm not sure how to embed it in our doc. Please find example output in attachment.

schema_doc.zip

[hcho3]

@trivialfis The output looks super nice. Let me see if I can get readthedocs run the generator automatically.

[KOLANICH]

IMHO:

1. minification is not needed
2. GH actions can be used for building and then the result can be deployed to GH pages.

[trivialfis]

@KOLANICH @hcho3 Not sure I like it. The output certainly looks nice, but I prefer static site.

[KOLANICH]

The output certainly looks nice, but I prefer static site.

I have already opened a bug about eliminating JS.
Probably a yet another needed about laying out everything to different pages like Doxygen does.