From 1239ade2750349d13d4e865d88449b232bbad944 Mon Sep 17 00:00:00 2001
From: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
Date: Mon, 11 Nov 2024 14:49:06 +0100
Subject: [PATCH] docs: add navigation indices (#305)

Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
---
 docs/concepts/index.md     | 3 +++
 docs/examples/index.md     | 3 +++
 docs/integrations/index.md | 3 +++
 mkdocs.yml                 | 5 ++++-
 4 files changed, 13 insertions(+), 1 deletion(-)
 create mode 100644 docs/concepts/index.md
 create mode 100644 docs/examples/index.md
 create mode 100644 docs/integrations/index.md

diff --git a/docs/concepts/index.md b/docs/concepts/index.md
new file mode 100644
index 00000000..a29db1af
--- /dev/null
+++ b/docs/concepts/index.md
@@ -0,0 +1,3 @@
+In this area you can find guides on the main Docling concepts.
+
+Use the navigation on the left to browse through them.
diff --git a/docs/examples/index.md b/docs/examples/index.md
new file mode 100644
index 00000000..5c2d3acd
--- /dev/null
+++ b/docs/examples/index.md
@@ -0,0 +1,3 @@
+In this area you can find examples covering a range of possible workflows and use cases.
+
+Use the navigation on the left to browse through them.
diff --git a/docs/integrations/index.md b/docs/integrations/index.md
new file mode 100644
index 00000000..c09c917d
--- /dev/null
+++ b/docs/integrations/index.md
@@ -0,0 +1,3 @@
+In this area you can find guides on the Docling integrations with popular frameworks and tools.
+
+Use the navigation on the left to browse through them.
diff --git a/mkdocs.yml b/mkdocs.yml
index 1fef4428..2ce244bd 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -39,7 +39,7 @@ theme:
     - content.code.copy
     - announce.dismiss
     - navigation.tabs
-    # - navigation.indexes  # <= if set, each "section" can have its own page, if index.md is used
+    - navigation.indexes  # <= if set, each "section" can have its own page, if index.md is used
     - navigation.instant
     - navigation.instant.prefetch
     # - navigation.instant.preview
@@ -57,9 +57,11 @@ nav:
     - Usage: usage.md
     - Docling v2: v2.md
   - Concepts:
+    - Concepts: concepts/index.md
     - Docling Document: concepts/docling_document.md
   #   - Chunking: concepts/chunking.md
   - Examples:
+    - Examples: examples/index.md
     - Conversion:
       - "Simple conversion": examples/minimal.py
       - "Custom conversion": examples/custom_convert.py
@@ -77,6 +79,7 @@ nav:
     # - CLI:
     #   - CLI: examples/cli.md
   - Integrations:
+    - Integrations: integrations/index.md
     - "LlamaIndex 🦙 extension": integrations/llamaindex.md
     # - "LangChain 🦜🔗 extension": integrations/langchain.md
   # - API reference: