-
Notifications
You must be signed in to change notification settings - Fork 17
Add documentation for DANDI models #176
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
Conversation
dd666ea to
76c0183
Compare
|
don't we want this to be generated from the linkml automatically? (cc:ing @djarecka ) |
this is documentation of the life cycle (where produced, into what form transformed - e.g. jsonschema, used by what - e.g. dandi-cli, web UI, etc) of our metadata model, not documentation/visualization of metadata itself. @candleindark might want to adjust title to make it more explicit. |
7cd729e to
2bebdee
Compare
File name, heading, and navigation trigger have been modified to reflect the nature of content. |
This documentation is not about the specifics of the models themselves, but how they are integrated in the DANDI ecosystem.
2bebdee to
9ea436c
Compare
|
Looks great, thank you @candleindark ! To facilitate demonstration etc, I will just proceed with the merge, but feel welcome to submit improvements in PRs etc. |
The mkdocs-material dependency needs to be upgraded to a newer version to render the mermaid diagram submitted via dandi#176
This PR adds documentation of the definition and usage of DANDI models.
This PR provides a documentation on how DANDI metadata models are integrated across the DANDI ecosystem. The specific changes are: