Add compatibility note to evolving models

kstich · kstich · commit 5dd0b4516058 · 2023-03-10T10:27:56.000-08:00
diff --git a/docs/source-1.0/guides/evolving-models.rst b/docs/source-1.0/guides/evolving-models.rst
@@ -5,6 +5,13 @@ Evolving Models
 This guide describes how to evolve Smithy models without breaking your
 customers.
 
+   .. note::
+
+       This page does not include every possible backwards or forwards
+       compatible change. For traits, the best place to look for compatibility
+       is the specification for the trait or its model definition as defined by
+       the :ref:`breaking changes property <trait-breaking-change-rules>`.
+
 
 Updating services
 =================
diff --git a/docs/source-2.0/guides/evolving-models.rst b/docs/source-2.0/guides/evolving-models.rst
@@ -5,6 +5,13 @@ Evolving Models
 This guide describes how to evolve Smithy models without breaking your
 customers.
 
+   .. note::
+
+       This page does not include every possible backwards or forwards
+       compatible change. For traits, the best place to look for compatibility
+       is the specification for the trait or its model definition as defined by
+       the :ref:`breaking changes property <trait-breaking-change-rules>`.
+
 Updating services
 =================
 
