Skip to content

Commit

Permalink
docs: add navigation indices (#305)
Browse files Browse the repository at this point in the history
Signed-off-by: Panos Vagenas <[email protected]>
  • Loading branch information
vagenas authored Nov 11, 2024
1 parent 97f214e commit 1239ade
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
@@ -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 changes: 3 additions & 0 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/integrations/index.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand Down

0 comments on commit 1239ade

Please sign in to comment.