Generate docs from schema files and store them in this repository#118
Merged
neilmb merged 27 commits intotiger-teamfrom Apr 3, 2026
Merged
Generate docs from schema files and store them in this repository#118neilmb merged 27 commits intotiger-teamfrom
neilmb merged 27 commits intotiger-teamfrom
Conversation
Collaborator
Author
|
Generated markdown docs can be seen in https://github.com/GSA/dcat-us/tree/nmb/generate-docs/jsonschema/docs |
jbrown-xentity
approved these changes
Apr 1, 2026
Collaborator
jbrown-xentity
left a comment
There was a problem hiding this comment.
This documentation provides accurate representation of the schema. There is more iterative work to do in the future related to styling, simplification, etc, but this should be good as-is.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This addresses #71
We generate Markdown format documentation directly from the JSON schema files and store the documentation here in the same repository. To make better and more readable documentation, this adds more
titleattributes in the schema.