Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mrshll1001 opened this issue Sep 12, 2024 · 0 comments
Open

Comments

@mrshll1001
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant