From b29ad797c5b61f6ac7e27fbae77d4ac8d2881e8b Mon Sep 17 00:00:00 2001
From: Sami Mazouz <sychocouldy@gmail.com>
Date: Sat, 12 Oct 2024 13:28:16 +0100
Subject: [PATCH] docs

---
 .../js/src/admin/states/GeneralSearchIndex.ts | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/framework/core/js/src/admin/states/GeneralSearchIndex.ts b/framework/core/js/src/admin/states/GeneralSearchIndex.ts
index 14d5a0d336..2b60847fe1 100644
--- a/framework/core/js/src/admin/states/GeneralSearchIndex.ts
+++ b/framework/core/js/src/admin/states/GeneralSearchIndex.ts
@@ -1,9 +1,28 @@
 export type GeneralIndexItem = {
+  /**
+   * The unique identifier for this index item.
+   */
   id: string;
+  /**
+   * Optional: The tree path to this item, used for grouping in the search results.
+   */
   tree?: string[];
+  /**
+   * The label to display in the search results.
+   */
   label: string;
+  /**
+   * Optional: The description to display in the search results.
+   */
   help?: string;
+  /**
+   * Optional: The URL to navigate to when this item is selected.
+   * The default is to navigate to the extension page.
+   */
   link?: string;
+  /**
+   * Optional: A callback that returns a boolean indicating whether this item should be visible in the search results.
+   */
   visible?: () => boolean;
 };