From 24c64057c81ebab9cf0b34d7f2db4eb90df7262e Mon Sep 17 00:00:00 2001 From: Larry Babb Date: Thu, 31 Oct 2024 14:51:54 -0400 Subject: [PATCH] minor doc edits and updates for PRC review (#580) * add missing toc entry * issue #577 cross reference between feature maturity levels and class diagram --- docs/source/appendices/class_diagram.rst | 5 +++++ docs/source/appendices/index.rst | 12 +----------- docs/source/appendices/maturity_model.rst | 5 +++++ docs/source/concepts/index.rst | 1 + 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/source/appendices/class_diagram.rst b/docs/source/appendices/class_diagram.rst index 4a9bf4e4..023d71b1 100644 --- a/docs/source/appendices/class_diagram.rst +++ b/docs/source/appendices/class_diagram.rst @@ -3,6 +3,11 @@ Class Diagram !!!!!!!!!!!!! +Below is a class diagram of the VRS schema which provides a visual representation +of the class inheritance only not associations. Each class within the diagram is +tagged with the maturity level of the class in the upper right corner. The maturity +levels are defined in the :ref:`feature-maturity-levels` section. + .. figure:: ../images/schema-current.png Current VRS Class Inheritance Diagram diff --git a/docs/source/appendices/index.rst b/docs/source/appendices/index.rst index 5da710b5..fdebe54c 100644 --- a/docs/source/appendices/index.rst +++ b/docs/source/appendices/index.rst @@ -4,18 +4,8 @@ Appendices .. toctree:: :maxdepth: 2 - getting_involved - design_decisions - development_process + class_diagram maturity_model - future_plans - - implementations - relationships - associating_annotations - equivalence ga4gh_identifiers truncated_digest_collision_analysis - - faq glossary diff --git a/docs/source/appendices/maturity_model.rst b/docs/source/appendices/maturity_model.rst index bbb98deb..9f09b4e2 100644 --- a/docs/source/appendices/maturity_model.rst +++ b/docs/source/appendices/maturity_model.rst @@ -43,9 +43,14 @@ adoption by the community. model, enabling adopters to engage at a time that is appropriate for their organizational needs.* +.. _feature-maturity-levels: + Feature Maturity levels @@@@@@@@@@@@@@@@@@@@@@@ +It may be helpful to visualize the application of maturity levels by viewing the +current :ref:`classDiagram`. + .. figure:: ../images/maturity_levels.png :width: 800 diff --git a/docs/source/concepts/index.rst b/docs/source/concepts/index.rst index 1c1b9ed2..30975554 100644 --- a/docs/source/concepts/index.rst +++ b/docs/source/concepts/index.rst @@ -19,3 +19,4 @@ These models exist across several related domains: LocationAndReference/index SequenceExpression/index AdditionalDataTypes/index + \ No newline at end of file