docs: add architecture outline (#341)

Signed-off-by: Panos Vagenas <[email protected]>
DS4SD · Nov 15, 2024 · 25fd149 · 25fd149
1 parent 835e077
commit 25fd149
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 9 deletions.
diff --git a/docs/assets/docling_arch.png b/docs/assets/docling_arch.png
diff --git a/docs/assets/docling_arch.pptx b/docs/assets/docling_arch.pptx
diff --git a/docs/concepts/architecture.md b/docs/concepts/architecture.md
@@ -0,0 +1,19 @@
+![docling_architecture](../assets/docling_arch.png)
+
+In a nutshell, Docling's architecture is outlined in the diagram above.
+
+For each document format, the *document converter* knows which format-specific *backend* to employ for parsing the document and which *pipeline* to use for orchestrating the execution, along with any relevant *options*.
+
+!!! tip
+
+    While the document converter holds a default mapping, this configuration is parametrizable, so e.g. for the PDF format, different backends and different pipeline options can be used — see [Usage](../usage.md#adjust-pipeline-features).
+
+The *conversion result* contains the [*Docling document*](./docling_document.md), Docling's fundamental document representation.
+
+Some typical scenarios for using a Docling document include directly calling its *export methods*, such as for markdown, dictionary etc., or having it chunked by a *chunker*.
+
+For more details on Docling's architecture, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869).
+
+!!! note
+
+    The components illustrated with dashed outline indicate base classes that can be subclassed for specialized implementations.
diff --git a/docs/concepts/index.md b/docs/concepts/index.md
@@ -1,3 +1 @@
-In this area you can find guides on the main Docling concepts.
-
-Use the navigation on the left to browse through them.
+Use the navigation on the left to browse some core Docling concepts.
diff --git a/docs/examples/index.md b/docs/examples/index.md
@@ -1,3 +1 @@
-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.
+Use the navigation on the left to browse through examples covering a range of possible workflows and use cases.
diff --git a/docs/integrations/index.md b/docs/integrations/index.md
@@ -1,3 +1 @@
-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.
+Use the navigation on the left to browse through Docling integrations with popular frameworks and tools.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -58,6 +58,7 @@ nav:
     - Docling v2: v2.md
   - Concepts:
     - Concepts: concepts/index.md
+    - Architecture: concepts/architecture.md
     - Docling Document: concepts/docling_document.md
   #   - Chunking: concepts/chunking.md
   - Examples: