improve documentation of the EmbeddingTargetId type

DisyInformationssysteme · Feb 13, 2024 · d330b1f · d330b1f
1 parent 7da44d0
commit d330b1f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Improved the documentation and types of events.
+- Improved the documentation of the `EmbeddingTargetId` and `ExternalLinkKey` types.
 - Improved logging
 
 ### Fixed

diff --git a/src/cadenza.js b/src/cadenza.js
@@ -28,7 +28,18 @@ globalThis.cadenza = Object.assign(
   },
 );
 
-/** @typedef {string} EmbeddingTargetId - The ID of an embedding target */
+/**
+ * @typedef {string} EmbeddingTargetId - The ID of a Cadenza embedding target
+ *
+ * Embedding targets are called 🇩🇪 "Einbettbarer Inhalt" / 🇺🇸 "Embeddable content" throughout the Cadenza UI and help.
+ * They're managed within the respective workbook:
+ *
+ * - 🇩🇪 "Mehr" > "Arbeitsmappe verwalten" > "Einbettung"
+ * - 🇺🇸 "More" > "Manage workbook" > "Embedding"
+ *
+ * The name of an embedding target (as entered in the UI) is its ID.
+ */
+
 /** @typedef {string} GlobalId - The ID of a navigator item */
 
 /**