clingen-data-model / allele

Documentation for data model of ClinGen
10 stars 2 forks source link

"modernize" allele documentation #184

Closed bpow closed 3 years ago

bpow commented 7 years ago

I don't know whether "modernize", or whether the goal should be to "harmonize" with how we document the interpretation model. We are not consistent within the allele model--

For instance source/allele/resource/reference_sequence/index.md.erb has a "context" in the middleman header info that generates a "Definitions and Bindings" section-- I think this would transform relatively easily into a framework similar to what we use for the interpretation model (or avro, or something else...)

The resource model for CanonicalAllele has this context. On the other hand, source/resource/gene/index.md.erb doesn't have this at all. ContextualAllele's resource model doc looks the same as those generated from a context, but it actually looks like this was hand-written in markdown (ick!?!).

Should we just try to structure those parts of the resource model that are not currently structured? Should we try to do the same from the resource model.

@larrybabb : I think you did most of the work for the xsds, do you think they are up-to-date with the rest of the structures, and if so could we work from there? Or perhaps generate something from the modeling tool you used?