openreferral/hsds_example_profile

Consider adding Example and/or Schema tabs in Schema Reference page

Opened this issue · 0 comments

The vanilla HSDS docs schema reference page includes three tabs on each schema reference table:

  • Fields
  • Schema
  • Example

The documentation tools in this repo only generate the schema table with no tabs. This is mostly because the examples need to be hand-coded, and the "Schema" tab only shows the JSON Schema for that object; information which is readily available — and more human-readable — in the table format.

However we could adjust the documentation to generate these tabs by default and let people take them away. The example tab could point to some stand-in JSON which declares that a Profile author needs to create their own examples.