Documentation Generator

[thclark]

Feature request

Use Case

The standard will need to be PDF based so we'll need to have a basic description of the core elements of the schema. However, the opportunity for the documentation to get out-of-sync with the schema is rife.

There's also a "source of truth" problem where the schema will contain one set of information and the documentation could vary.

Current state

No solution yet.

Proposed Solution

This is solvable with a small script to generate documentation directly from the schema description elements.
Automate the script execution on a GitHub Action to update the description section on push.

[thclark]

This turned out to be considerably harder than expected to actually meaningfully extract structure from the whole document, but if anyone wants to have a go at simply extracting a glossary, that'd be great.