Merge pull request #9 from shcherbak-ai/dev

docs: docx converter desc. update

Author: SergiiShcherbak

README.md

@@ -257,11 +257,11 @@ See more examples in the documentation:
 
 ## 🔄 Document converters
 
-To create a document for analysis, you can either pass raw text directly, or use ContextGem's built-in document converters that handle various file formats.
+To create a ContextGem document for LLM analysis, you can either pass raw text directly, or use built-in converters that handle various file formats.
 
 ### 📄 DOCX converter
 
-ContextGem provides built-in converter to easily transform DOCX files into ContextGem document objects.
+ContextGem provides built-in converter to easily transform DOCX files into LLM-ready data.
 
 - Extracts information that other open-source tools often do not capture: misaligned tables, comments, footnotes, textboxes, headers/footers, and embedded images
 - Preserves document structure with rich metadata for improved LLM analysis
@@ -273,7 +273,7 @@ from contextgem import DocxConverter
 
 converter = DocxConverter()
 
-# Convert a DOCX file to a ContextGem Document
+# Convert a DOCX file to an LLM-ready ContextGem Document
 # from path
 document = converter.convert("path/to/document.docx")
 # or from file object

dev/notebooks/readme/docx_converter.ipynb

@@ -39,7 +39,7 @@
         "\n",
         "converter = DocxConverter()\n",
         "\n",
-        "# Convert a DOCX file to a ContextGem Document\n",
+        "# Convert a DOCX file to an LLM-ready ContextGem Document\n",
         "# from path\n",
         "document = converter.convert(\"path/to/document.docx\")\n",
         "# or from file object\n",

dev/readme.template.md

@@ -86,11 +86,11 @@ See more examples in the documentation:
 
 ## 🔄 Document converters
 
-To create a document for analysis, you can either pass raw text directly, or use ContextGem's built-in document converters that handle various file formats.
+To create a ContextGem document for LLM analysis, you can either pass raw text directly, or use built-in converters that handle various file formats.
 
 ### 📄 DOCX converter
 
-ContextGem provides built-in converter to easily transform DOCX files into ContextGem document objects.
+ContextGem provides built-in converter to easily transform DOCX files into LLM-ready data.
 
 - Extracts information that other open-source tools often do not capture: misaligned tables, comments, footnotes, textboxes, headers/footers, and embedded images
 - Preserves document structure with rich metadata for improved LLM analysis

dev/usage_examples/readme/docx_converter.py

@@ -4,7 +4,7 @@
 
 converter = DocxConverter()
 
-# Convert a DOCX file to a ContextGem Document
+# Convert a DOCX file to an LLM-ready ContextGem Document
 # from path
 document = converter.convert("path/to/document.docx")
 # or from file object

docs/docs-raw-for-llm.txt

@@ -4439,7 +4439,7 @@ DOCX Converter
 **************
 
 ContextGem provides built-in converter to easily transform DOCX files
-into ContextGem document objects.
+into LLM-ready ContextGem document objects.
 
 * 📑 Extracts information that other open-source tools often do not
   capture: misaligned tables, comments, footnotes, textboxes,
@@ -4461,7 +4461,7 @@ into ContextGem document objects.
 
    converter = DocxConverter()
 
-   # Convert a DOCX file to a ContextGem Document
+   # Convert a DOCX file to an LLM-ready ContextGem Document
    # from path
    document = converter.convert("path/to/document.docx")
    # or from file object
@@ -5685,7 +5685,7 @@ class contextgem.public.converters.DocxConverter
 
          converter = DocxConverter()
 
-         # Convert a DOCX file to a ContextGem Document
+         # Convert a DOCX file to an LLM-ready ContextGem Document
          # from path
          document = converter.convert("path/to/document.docx")
          # or from file object

docs/source/converters/docx.rst

@@ -18,7 +18,7 @@
 DOCX Converter
 ===============
 
-ContextGem provides built-in converter to easily transform DOCX files into ContextGem document objects.
+ContextGem provides built-in converter to easily transform DOCX files into LLM-ready ContextGem document objects.
 
 * 📑 Extracts information that other open-source tools often do not capture: misaligned tables, comments, footnotes, textboxes, headers/footers, and embedded images
 * 🧩 Preserves document structure with rich metadata for improved LLM analysis