search

SignalK / specification

Signal K is a JSON-based format for storing and sharing marine data from different sources (e.g. nmea 0183, 2000, seatalk, etc)
Other
92 stars 69 forks source link

Convert docs to use verified json samples #433

Closed bkp7 closed 6 years ago

bkp7 commented 6 years ago

I have implemented the changes required to achieve inserting validated json into md files as part of the publish process per #417.

Docs modified to include links to new sample files containing validated json.

Docs are updated as part of the docs production in docs:prep

I've also checked that the format of the links used is compatible with npm, GitHub and Gitbook docs. I have produced all the documentation to check the pdf production is OK.

tkurki commented 6 years ago

If I rebase this on master and do npm run docs:prep && npm run docs:serve I end up with

image

bkp7 commented 6 years ago

Sorry, my mistake, the version insert part of the docs:prep script isn't cross platform due to (replace version $npm_package_version gitbook-docs/*) and I messed it up. Reverted now. Tested docs:prep script on Linux and all OK now.

tkurki commented 6 years ago

Could you please rebase on master & fix?

bkp7 commented 6 years ago

Rebased on master, fixed and flattened.

tkurki commented 6 years ago

This is really cool, thank you! The next level would be to generate the samples with real software, then validate, then include like this in the docs.