Skip to content

Conversation

@candleindark
Copy link
Member

@candleindark candleindark commented Feb 11, 2025

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:

  1. Adding a new section on models integration
  2. Updating the navigation to include this new section
  3. Enabling support for mermaid diagrams to display the mermaid diagram in this new section

@candleindark candleindark force-pushed the dandi-models branch 2 times, most recently from dd666ea to 76c0183 Compare February 12, 2025 19:34
@satra
Copy link
Member

satra commented Feb 12, 2025

don't we want this to be generated from the linkml automatically? (cc:ing @djarecka )

@yarikoptic
Copy link
Member

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.

@candleindark
Copy link
Member Author

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.

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.
@candleindark candleindark marked this pull request as ready for review February 13, 2025 05:49
@yarikoptic
Copy link
Member

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.

@yarikoptic yarikoptic merged commit ca16905 into dandi:master Feb 13, 2025
2 checks passed
@yarikoptic yarikoptic added documentation Improvements or additions to documentation metadata labels Feb 13, 2025
@candleindark candleindark deleted the dandi-models branch February 19, 2025 06:48
candleindark added a commit to candleindark/dandi-docs that referenced this pull request Feb 19, 2025
The mkdocs-material dependency needs to be upgraded to a newer
version to render the mermaid diagram submitted via
dandi#176
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation metadata

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants