Skip to content

Generate docs from schema files and store them in this repository#118

Merged
neilmb merged 27 commits intotiger-teamfrom
nmb/generate-docs
Apr 3, 2026
Merged

Generate docs from schema files and store them in this repository#118
neilmb merged 27 commits intotiger-teamfrom
nmb/generate-docs

Conversation

@neilmb
Copy link
Copy Markdown
Collaborator

@neilmb neilmb commented Apr 1, 2026

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 title attributes in the schema.

@neilmb
Copy link
Copy Markdown
Collaborator Author

neilmb commented Apr 1, 2026

Generated markdown docs can be seen in https://github.com/GSA/dcat-us/tree/nmb/generate-docs/jsonschema/docs

Copy link
Copy Markdown
Collaborator

@jbrown-xentity jbrown-xentity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@zopalmer14 zopalmer14 added documentation Improvements or additions to documentation ready-for-review labels Apr 2, 2026
@zopalmer14 zopalmer14 linked an issue Apr 2, 2026 that may be closed by this pull request
@zopalmer14 zopalmer14 added the enhancement New feature or request label Apr 2, 2026
@neilmb neilmb merged commit 23c3757 into tiger-team Apr 3, 2026
3 checks passed
@jbrown-xentity jbrown-xentity mentioned this pull request Apr 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation to manage the standard

3 participants