Skip to content

Design document to refactor access to JSONSchema serialization of dandi-schema's dandiset.json #2381

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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

yarikoptic
Copy link
Member

@yarikoptic yarikoptic commented May 15, 2025

Metadata life-cycle inspired by the one we created for BIDS: see bids-standard/bids-website#626

Even if we decide to not anyhow proceed with this design doc, might be worth clarifying and extracting the mermaid diagram to be embedded in the docs for the developers.

You can see the diagram rendered at https://github.com/dandi/dandi-archive/blob/doc-design-jsonschema-runtime/doc/design/vendored-schema-1.md . Here is a preview which might get outdated

image

TODOs

  • add adjusted copy of the diagram which would depict new flow
  • accompany with a candidate implementation PR (WiP using claude code)

Metadata lifecycle inspired by the one we created for BIDS:
see bids-standard/bids-website#626
@yarikoptic yarikoptic added documentation Changes only affect the documentation design-doc Involves creating or discussing a design document labels May 15, 2025
@yarikoptic yarikoptic changed the title Design document with a diagram of metadata life cycle Design document to refactor access to JSONSchema serialization of dandi-schema's dandiset.json May 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design-doc Involves creating or discussing a design document documentation Changes only affect the documentation
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

1 participant