recipe and maturity docs

ga4gh · Nov 27, 2024 · 99ff0f9 · 99ff0f9
1 parent 470b600
commit 99ff0f9
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 12 deletions.
diff --git a/docs/source/appendices/index.rst b/docs/source/appendices/index.rst
@@ -8,9 +8,6 @@ Appendices
 .. toctree::
    :maxdepth: 2
 
+   maturity_model
    design_decisions
    faq
-
-
-
-
diff --git a/docs/source/appendices/maturity_model.rst b/docs/source/appendices/maturity_model.rst
@@ -0,0 +1 @@
+../../../submodules/vrs/docs/source/appendices/maturity_model.rst
diff --git a/docs/source/concepts/catvrs_model.rst b/docs/source/concepts/catvrs_model.rst
@@ -6,7 +6,7 @@ Cat-VRS Model
 The following data types classes are used by Cat-VRS but maintained by either the VRS subgroup 
 or across the GKS Work Stream as core data classes.
 
-.. _categorical_variant:
+.. _CategoricalVariant:
 
 Categorical Variant
 ###################
@@ -27,28 +27,28 @@ other constraint classes.  A constraint is a rule or set of rules that
 must be satisfied for a CategoricalVariant to be considered valid.
 Constraint sub classes are only used in CategoricalVariant objects.
 
-.. _defining_allele_constraint:
+.. _DefiningAlleleConstraint:
 
 DefiningAlleleConstraint
 ########################
 
 .. include:: ../def/cat-vrs/DefiningAlleleConstraint.rst
 
-.. _defining_location_constraint:
+.. _DefiningLocationConstraint:
 
 DefiningLocationConstraint
 ##########################
 
 .. include:: ../def/cat-vrs/DefiningLocationConstraint.rst
 
-.. _copy_count_constraint:
+.. _CopyCountConstraint:
 
 CopyCountConstraint
 ###################
 
 .. include:: ../def/cat-vrs/CopyCountConstraint.rst
 
-.. _copy_change_constraint:
+.. _CopyChangeConstraint:
 
 CopyChangeConstraint
 ####################

diff --git a/docs/source/concepts/recipes.rst b/docs/source/concepts/recipes.rst
@@ -12,23 +12,40 @@ to use the recipes that exist whenever possible, but are free to create
 new recipes as needed in a given implementation. New recipes should be
 shared with the community on the |catvrs_discussion| board.
 
-.. _canonical_allele:
+.. _CanonicalAllele:
 
 CanonicalAllele
 !!!!!!!!!!!!!!!
 
 .. include:: ../def/cat-vrs/CanonicalAllele.rst
 
-.. _protein_sequence_consequence:
+The CanonicalAllele is a :ref:`CategoricalVariant` with exactly one constraint:
+
+1. A :ref:`DefiningAlleleConstraint` with the `.relations` array containing both
+   `liftover_to` and `transcribes_to` codes. This constraint MUST refer to a genomic 
+   variant for the `allele`.
+
+.. _ProteinSequenceConsequence:
 
 ProteinSequenceConsequence
 !!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. include:: ../def/cat-vrs/ProteinSequenceConsequence.rst
 
-.. _categorical_cnv:
+The ProteinSequenceConsequence is a :ref:`CategoricalVariant` with exactly one constraint:
+
+1. A :ref:`DefiningAlleleConstraint` with the `.relations` array containing only a
+   `translates_from` code. This constraint MUST refer to a protein variant for the `allele`.
+
+.. _categorical-cnv:
 
 CategoricalCnv
 !!!!!!!!!!!!!!
 
 .. include:: ../def/cat-vrs/CategoricalCnv.rst
+
+The CategoricalCNV is a :ref:`CategoricalVariant` with exactly two constraints:
+
+1. A :ref:`DefiningLocationConstraint` with the `.relations` array containing only a
+   `liftover_to` code.
+2. A :ref:`CopyChangeConstraint` or `CopyCountConstraint`.
diff --git a/docs/source/images/adoption_lifecycle.png b/docs/source/images/adoption_lifecycle.png
@@ -0,0 +1 @@
+../../../submodules/vrs/docs/source/images/adoption_lifecycle.png
diff --git a/docs/source/images/maturity_levels.png b/docs/source/images/maturity_levels.png
@@ -0,0 +1 @@
+../../../submodules/vrs/docs/source/images/maturity_levels.png