chore: various minor docs fixes (#169)

Signed-off-by: Panos Vagenas <[email protected]>

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/ds4sd/docling">
-    <img loading="lazy" alt="Docling" src="docs/assets/docling_processing.png" width="100%"/>
+    <img loading="lazy" alt="Docling" src="https://github.com/DS4SD/docling/raw/main/docs/assets/docling_processing.png" width="100%"/>
   </a>
 </p>
 
@@ -50,7 +50,7 @@ To convert individual documents, use `convert()`, for example:
 ```python
 from docling.document_converter import DocumentConverter
 
-source = "https://arxiv.org/pdf/2408.09869"  # PDF path or URL
+source = "https://arxiv.org/pdf/2408.09869"  # document per local path or URL
 converter = DocumentConverter()
 result = converter.convert(source)
 print(result.document.export_to_markdown())  # output: "## Docling Technical Report[...]"

docs/examples/minimal.py

@@ -1,10 +1,7 @@
 from docling.document_converter import DocumentConverter
 
-source = "https://arxiv.org/pdf/2408.09869"  # PDF path or URL
+source = "https://arxiv.org/pdf/2408.09869"  # document per local path or URL
 converter = DocumentConverter()
 result = converter.convert(source)
-print(
-    result.document.export_to_markdown()
-)  # output: ## Docling Technical Report [...]"
-# if the legacy output is needed, use this version
-# print(result.legacy_document.export_to_markdown())  # output: ## Docling Technical Report [...]"
+print(result.document.export_to_markdown())
+# output: ## Docling Technical Report [...]"

docs/index.md

@@ -1,9 +1,7 @@
 # Docling
 
 <p align="center">
-  <a href="https://ds4sd.github.io/docling/">
-    <img loading="lazy" alt="Docling" src="assets/logo.png" width="150" />
-  </a>
+  <img loading="lazy" alt="Docling" src="assets/docling_processing.png" width="100%" />
 </p>
 
 

docs/usage.md

@@ -27,10 +27,10 @@ To see all available options (export formats etc.) run `docling --help`.
 <details>
   <summary><b>CLI reference</b></summary>
 
-  Here are the available options as of this writing (for an up-to-date listing, run `docling --help`):
+Here are the available options as of this writing (for an up-to-date listing, run `docling --help`):
 
-  ```console
-  $ docling --help
+```console
+$ docling --help
 
  Usage: docling [OPTIONS] source
 
@@ -57,7 +57,7 @@ To see all available options (export formats etc.) run `docling --help`.
 │ --version                                                                     Show version information.                   │
 │ --help                                                                        Show this message and exit.                 │
 ╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-  ```
+```
 </details>