Add JSON Documentation & Document Generator #180
Conversation
|
I've now added the more basic descriptions to this PR and many of the descriptions which already exist in the current documentation |
37c8a3a to
7a59f76
Compare
test adding github action A FIX TABS fix tabs but actually save remove java from doc checker test doc check check hashes restore
7a59f76 to
df5469f
Compare
There was a problem hiding this comment.
Just some pre-review comments.
Also, what do you think about relocating the files to gencode/docs rather than docs/schema? The reason is that it's nice to keep everything that's automatically generated in one place so it doesn't get mixed in with manual edits. Right now, everything else in gencode/ is automatically generated, so seems reasonable.
validator_config.json
Outdated
| @@ -0,0 +1,7 @@ | |||
| { | |||
There was a problem hiding this comment.
this file should not be comitted! Likely need to add it to .gitignore or similar.
.github/workflows/testing.yml
Outdated
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: schema docs | ||
| run: bin/gendocs check |
|
Resolved pre-review comments and moved directory into gencode/docs. Most of the more straightforward definitions which already exist in the current documentation have been copied over, rest of definitions to come later. New web preview link - https://noursaidi.github.io/udmi/gencode/docs/ |
|
Indent fixed - ready to be merged now |
Adds document generator to convert JSON schema into HTML files. Also included the HTML version of the current schema.
Preview - https://noursaidi.github.io/udmi/schema/index.html
Suggest that GitHub Pages is enabled on the docs directory to allow it to be viewed nicely from the web.