From 0c36cb118d765180bb0d7f8ce5053a605e60081e Mon Sep 17 00:00:00 2001
From: Andrey Fedorov <andrey.fedorov@gmail.com>
Date: Thu, 1 Aug 2024 12:56:55 -0400
Subject: [PATCH] DOC: add brief descriptions for indices

---
 idc_index/index.py | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/idc_index/index.py b/idc_index/index.py
index 089b4a69..8eb26568 100644
--- a/idc_index/index.py
+++ b/idc_index/index.py
@@ -70,14 +70,18 @@ def __init__(self):
         )
 
         self.indices_overview = {
-            "index": {"description": None, "installed": True, "url": None},
+            "index": {
+                "description": "Main index containing one row per DICOM series.",
+                "installed": True,
+                "url": None,
+            },
             "sm_index": {
-                "description": None,
+                "description": "DICOM Slide Microscopy series-level index.",
                 "installed": False,
                 "url": f"{asset_endpoint_url}/sm_index.parquet",
             },
             "sm_instance_index": {
-                "description": None,
+                "description": "DICOM Slide Microscopy instance-level index.",
                 "installed": False,
                 "url": f"{asset_endpoint_url}/sm_instance_index.parquet",
             },