w3c / dpv

Data Privacy Vocabularies and Controls CG (DPVCG)
https://w3id.org/dpv
Other
33 stars 23 forks source link

Programmatic generation of documentation diagrams #24

Open coolharsh55 opened 2 years ago

coolharsh55 commented 2 years ago

Adding diagrams to present/explain:

  1. Taxonomy for each module, e.g. hierarchy of concepts under 'Purpose'
  2. Properties available under each module and their use e.g. 'Purpose'
  3. Properties possible for use for each concept, e.g. 'Store' as a processing category can use hasLocation, hasStorage, hasDuration (tbd)

Diagrams depend on concepts, which may change over time. Their generation, therefore, should be preferably programmatic. It should not add a burden to the development and should not be 'difficult' to modify or understand in case changes need to be made. Some available opportunities to explore for this:

coolharsh55 commented 2 years ago

https://harshp.com/dpv-x/documentation-generator-diagrams/ (edited link for demo) Trying to autogenerate svg for each concept using GraphViz