From ae30373ee7fd5e91e24511eb06d6b24a7bc79e07 Mon Sep 17 00:00:00 2001 From: Robyn Johnson Date: Fri, 14 Nov 2025 06:29:25 -0600 Subject: [PATCH] docs: combine Home and Getting Started pages (#2600) * Update mkdocs.yml Remove navigations.sections feature so that navigation menus will collapse & expand. They are collapsed by default. * docs: add sign-off DCO Remediation Commit for Robyn J I, Robyn J , hereby add my Signed-off-by to this commit: b7d74418278462bb6633c45d2d37157b781f6b8d Signed-off-by: Robyn J * docs: Combine Home and Getting Started page Combine home and getting stated pages, and rename the page "Documentation" Signed-off-by: Robyn J --------- Signed-off-by: Robyn J --- docs/getting_started/index.md | 17 ----------------- docs/index.md | 21 +++++++++++++++++++-- mkdocs.yml | 6 ++---- 3 files changed, 21 insertions(+), 23 deletions(-) diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index e7fee02d..8b137891 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -1,18 +1 @@ -🐣 Ready to kick off your Docling journey? Let's dive right into it! -
- ⬇️ Installation
Quickly install Docling in your environment - ▶️ Usage
Get a jumpstart on basic Docling usage - 🧩 Concepts
Learn Docling fundamentals and get a glimpse under the hood - 🧑🏽‍🍳 Examples
Try out recipes for various use cases, including conversion, RAG, and more - 🤖 Integrations
Check out integrations with popular AI tools and frameworks - 📖 Reference
See more API details -
- -## What's next - -🚀 The journey has just begun! Join us and become a part of the growing Docling community! - -- :fontawesome-brands-github: GitHub -- :fontawesome-brands-discord: Discord -- :fontawesome-brands-linkedin: LinkedIn diff --git a/docs/index.md b/docs/index.md index d440adeb..601930db 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,6 +20,19 @@ Docling simplifies document processing, parsing diverse formats — including advanced PDF understanding — and providing seamless integrations with the gen AI ecosystem. +## Getting started + +🐣 Ready to kick off your Docling journey? Let's dive right into it! + +
+ ⬇️ Installation
Quickly install Docling in your environment + ▶️ Usage
Get a jumpstart on basic Docling usage + 🧩 Concepts
Learn Docling fundamentals and get a glimpse under the hood + 🧑🏽‍🍳 Examples
Try out recipes for various use cases, including conversion, RAG, and more + 🤖 Integrations
Check out integrations with popular AI tools and frameworks + 📖 Reference
See more API details +
+ ## Features * 🗂️ Parsing of [multiple document formats][supported_formats] incl. PDF, DOCX, PPTX, XLSX, HTML, WAV, MP3, VTT, images (PNG, TIFF, JPEG, ...), and more @@ -46,9 +59,13 @@ Docling simplifies document processing, parsing diverse formats — including ad * 📝 Chart understanding (Barchart, Piechart, LinePlot, etc) * 📝 Complex chemistry understanding (Molecular structures) -## Get started +## What's next -Check out our [getting started](./getting_started/index.md) page to get the ball rolling! +🚀 The journey has just begun! Join us and become a part of the growing Docling community! + +- :fontawesome-brands-github: GitHub +- :fontawesome-brands-discord: Discord +- :fontawesome-brands-linkedin: LinkedIn ## Live assistant diff --git a/mkdocs.yml b/mkdocs.yml index 672d8448..24bd63f1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,10 +52,8 @@ theme: - search.suggest - toc.follow nav: - - Home: - - "Docling": index.md - - Getting started: - - Getting started: getting_started/index.md + - Documentation: + - "Docling documentation": index.md - Installation: - Installation: installation/index.md - Usage: