Skip to content
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

Programmatic generation of documentation diagrams #24

Open
coolharsh55 opened this issue Jul 18, 2021 · 2 comments
Open

Programmatic generation of documentation diagrams #24

coolharsh55 opened this issue Jul 18, 2021 · 2 comments

Comments

@coolharsh55
Copy link
Collaborator

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
Copy link
Collaborator Author

coolharsh55 commented Aug 6, 2021

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

@coolharsh55 coolharsh55 added this to the DPV v1 milestone Jun 30, 2022
@coolharsh55 coolharsh55 changed the title Diagrams in documentation for better view of concepts Programmatic generation of documentation diagrams Nov 30, 2022
@coolharsh55 coolharsh55 removed this from the DPV v1 milestone May 10, 2023
@coolharsh55 coolharsh55 added this to the dpv v2.1 milestone Apr 13, 2024
@coolharsh55
Copy link
Collaborator Author

We have used plantuml for the diagrams in DPV 2.0 docs - which can be used to automatically update the source files as concepts change in the future, thus ensuring diagrams are always up to date. Some creative querying/filtering would be needed to select specifically those concepts represented in the diagrams - the modular structure of DPV and extensions will simplify this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant