set up github.io with schema as markdown (input for mkdocs)

Question

set up github.io with schema as markdown (input for mkdocs)

Opened this issue 3 years ago · 2 comments

Aim: generate browsable, human-readable documentation of DOSDP JSON SCHEMA

Research existing auto-documentation options - markdown output preferred, but we could use static html generator if better.
...

Answer 1 · 2021-05-04T07:35:37.000Z

First version of the auto-generated documentation exists here
Used jsonschema2md for basic generation and decorated by using a custom config file.
For this task, needed to update (such as adding doc_type etc.) existing schema a little: new schema
Can you share your recommendations for better a documentation.

Answer 2 · 2021-08-31T11:33:43.000Z

Mkdocs documentation publishing completed: https://incatools.github.io/dead_simple_owl_design_patterns/

Github action is triggered when; new release, updating README.md or files under docs/ (in the master branch only)