search

AMWA-TV / nmos-render-scripts

Build scripts for NMOS documentation
https://hub.docker.com/r/amwa/nmos-render
Apache License 2.0
1 stars 1 forks source link

NMOS Parameter Registers: constraint_set.json #37

Open garethsb opened 3 years ago

garethsb commented 3 years ago

The link in https://specs.amwa.tv/nmos-parameter-registers/branches/main/capabilities/ to https://specs.amwa.tv/nmos-parameter-registers/branches/main/capabilities/constraint_set.html gives a 404. The source JSON file has been copied across to https://specs.amwa.tv/nmos-parameter-registers/branches/main/capabilities/constraint_set.json, but should/could it be being rendered like example JSON files in the IS repos?

peterbrightwell commented 3 years ago

Fixed in:

https://github.com/AMWA-TV/nmos-doc-build-scripts/commit/0f6b08a20f13f003dbb28d4ba1c1efab46236c71

by adding (another 🙄 ) special case for NMOS-PARAMETER-REGISTERS that renders any JSON files in place (NB not using the flattened/with-refs option).

@garethsb using a PR was fiddly so can you check? Code is not optimal but hopefully will do pending rearranging param reg repos to be more like the others,

garethsb commented 2 years ago

This worked well... the JSON Schema is now published as both rendered HTML and as raw JSON.

This reminds me of the conversation in Slack about publishing the raw JSON Schemas for all specs, as well as the rendered HTML, so that there was an AMWA-controlled canonical URL for them which could be used in $ref.

I also meant to investigate if it would be possible to make the "breadcrumbs" for simpler navigation between the Parameter Registers?

garethsb commented 2 years ago

Now that we can have manual docs index files rather than using numbered doc files, would a top-level README.md in the parameter registers docs enable us to have breadcrumbs?