minor doc edits and updates for PRC review (ga4gh#580)

* add missing toc entry * issue ga4gh#577 cross reference between feature maturity levels and class diagram
clingen-data-model · Oct 31, 2024 · 24c6405 · 24c6405
1 parent 2d69dc1
commit 24c6405
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 11 deletions.
diff --git 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
@@ -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
@@ -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
@@ -19,3 +19,4 @@ These models exist across several related domains:
     LocationAndReference/index
     SequenceExpression/index
     AdditionalDataTypes/index
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,3 +19,4 @@ These models exist across several related domains:
		LocationAndReference/index
		SequenceExpression/index
		AdditionalDataTypes/index