docs: add navigation indices (#305)

Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
This commit is contained in:
Panos Vagenas 2024-11-11 14:49:06 +01:00 committed by GitHub
parent 97f214efdd
commit 1239ade275
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 13 additions and 1 deletions

3
docs/concepts/index.md Normal file
View File

@ -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.

3
docs/examples/index.md Normal file
View File

@ -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.

View File

@ -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.

View File

@ -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: