From 514252ffe675df5e2d8dbd9992747e2cdfe7bc36 Mon Sep 17 00:00:00 2001 From: Panos Vagenas <35837085+vagenas@users.noreply.github.com> Date: Thu, 17 Oct 2024 09:55:51 +0200 Subject: [PATCH] improve docling document concept page [skip ci] Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com> --- docs/concepts/{docling_format.md => docling_document.md} | 7 ++++--- mkdocs.yml | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) rename docs/concepts/{docling_format.md => docling_document.md} (87%) diff --git a/docs/concepts/docling_format.md b/docs/concepts/docling_document.md similarity index 87% rename from docs/concepts/docling_format.md rename to docs/concepts/docling_document.md index 2531b75c..7e05fea6 100644 --- a/docs/concepts/docling_format.md +++ b/docs/concepts/docling_document.md @@ -11,9 +11,10 @@ It also brings a set of document construction APIs to build up a `DoclingDocumen ## Example document structures -To illustrate the features of the `DoclingDocument` format, consider the following side-by-side comparison of a -`DoclingDocument` converted from `test/data/word_sample.docx`. Left side shows snippets from the converted document -serialized as YAML, right side shows the corresponding visual parts in MS Word. +To illustrate the features of the `DoclingDocument` format, in the subsections below we consider the +`DoclingDocument` converted from `tests/data/word_sample.docx` and we present some side-by-side comparisons, +where the left side shows snippets from the converted document +serialized as YAML and the right one shows the corresponding parts of the original MS Word. ### Basic structure diff --git a/mkdocs.yml b/mkdocs.yml index 58bdc254..1fef4428 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,7 +57,7 @@ nav: - Usage: usage.md - Docling v2: v2.md - Concepts: - - Docling Document: concepts/docling_format.md + - Docling Document: concepts/docling_document.md # - Chunking: concepts/chunking.md - Examples: - Conversion: