-
Notifications
You must be signed in to change notification settings - Fork 0
Description
Name: James Brown, james.c.brown@state.co.us
Affiliation: GSA, data.gov
Type of issue: Editorial
Issue: The documentation to manage the standard is so cumbersome and difficult to work with and requires human sync up between documentation and schema definitions. This has resulted in numerous errors, problems, etc. See #62 as example.
Recommended change(s): Suggest we move away from raw HTML and manual editing, and move to generated documentation based on JSON schema and other created markdown overview information. Suggest moving to something like https://github.com/jy95/docusaurus-json-schema-plugin, which can be seen as a demo here. Using different templates the schema can be generated into documentation, and kept in sync (ie the guidance and code are one and the same).