[doc] Add a shape to show a description in the new representation modal

gdaniel · gdaniel · commit 492e7cf3771e · 2026-03-03T16:54:43.000+01:00
Signed-off-by: Gwendal Daniel &lt;gwendal.daniel@obeosoft.com&gt;
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -6,6 +6,7 @@
 
 - Keep details tab open on selection change
 - Add support the for selection dialog that can be confirmed without making a selection
+- Add a description in the new representation modal
 
 === Architectural decision records
 
diff --git a/doc/iterations/2026.3/add_a_description_in_the_new_representation_modal.adoc b/doc/iterations/2026.3/add_a_description_in_the_new_representation_modal.adoc
@@ -0,0 +1,26 @@
+= Add a description in the new representation modal
+
+== Problem
+
+The name of a representation description may not be expressive enough to inform the user on what the description actually does.
+
+== Key Result
+
+Sirius Web should display a description of the selected representation in the new representation modal.
+
+=== Acceptance Criteria
+
+- A Cypress test should leverage the new functionality and validate the whole user experience.
+
+== Solution
+
+Sirius Web's backend will send the description as part of the representation description metadata already sent to display the content of the modal.
+A default implementation returning `RepresentationDescription#description` will be provided for representations defined with the view DSL.
+The description will be displayed under the representation drop down menu.
+image::images/new_representation_modal_with_description[The updated modal with the description of the representation, width=500, align=center]
+
+=== Cutting backs 
+
+== Rabbit holes
+
+== No-gos
diff --git a/doc/iterations/2026.3/images/new_representation_modal_with_description.png b/doc/iterations/2026.3/images/new_representation_modal_with_description.png
