📝 add auto-sync for md documentation (#252)

Author: sebastianMindee

.github/workflows/sync-readme.yml

@@ -0,0 +1,21 @@
+name: Sync `documentation` directory to ReadMe
+
+# Run workflow for every push to the `main` branch
+on:
+  workflow_dispatch:
+  release:
+    branches:
+      - main
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout this repo
+        uses: actions/checkout@v4
+
+      # Run GitHub Action to sync docs in `documentation` directory
+      - name: GitHub Action
+        uses: readmeio/rdme@v8
+        with:
+          rdme: docs ./docs/extras/guide --key=${{ secrets.README_API_KEY }} --version=1.0

README.md

@@ -133,7 +133,8 @@ Complete details on the working of the library are available in the following gu
 
 * [Getting started](https://developers.mindee.com/docs/python-getting-started)
 * [Python Command Line Interface (CLI)](https://developers.mindee.com/docs/python-cli)
-* [Python Custom APIs (API Builder)](https://developers.mindee.com/docs/python-api-builder)
+* [Python Generated](https://developers.mindee.com/docs/generated-api-python)
+* [Python Custom APIs (Deprecated - API Builder)](https://developers.mindee.com/docs/python-api-builder)
 * [Python Invoice OCR](https://developers.mindee.com/docs/python-invoice-ocr)
 * [Python International Id OCR](https://developers.mindee.com/docs/python-international-id-ocr)
 * [Python Resume OCR](https://developers.mindee.com/docs/python-resume-ocr)
@@ -146,15 +147,15 @@ Complete details on the working of the library are available in the following gu
 * [Python FR Bank Account Detail OCR](https://developers.mindee.com/docs/python-fr-bank-account-details-ocr)
 * [Python FR Carte Grise OCR](https://developers.mindee.com/docs/python-fr-carte-grise-ocr)
 * [Python FR Carte Vitale OCR](https://developers.mindee.com/docs/python-fr-carte-vitale-ocr)
-* [Python FR ID Card OCR](https://developers.mindee.com/docs/python-fr-id-card-ocr)
+* [Python FR ID Card OCR](https://developers.mindee.com/docs/python-fr-carte-nationale-didentite-ocr)
 * [Python FR Petrol Receipts OCR](https://developers.mindee.com/docs/python-fr-petrol-receipts-ocr)
 * [Python US Bank Check OCR](https://developers.mindee.com/docs/python-us-bank-checks-ocr)
 * [Python US W9 OCR](https://developers.mindee.com/docs/python-us-w9-ocr)
 * [Python US Driver License OCR](https://developers.mindee.com/docs/python-us-driver-license-ocr)
-* [Python Barcode Reader API](https://developers.mindee.com/docs/python-barcode-reader-api)
-* [Python Cropper API](https://developers.mindee.com/docs/python-cropper-api)
-* [Python Invoice Splitter API](https://developers.mindee.com/docs/python-invoice-splitter-api)
-* [Python Multi Receipts Detector API](https://developers.mindee.com/docs/python-multi-receipts-detector-api)
+* [Python Barcode Reader API](https://developers.mindee.com/docs/python-barcode-reader-ocr)
+* [Python Cropper API](https://developers.mindee.com/docs/python-cropper-ocr)
+* [Python Invoice Splitter API](https://developers.mindee.com/docs/python-invoice-splitter-ocr)
+* [Python Multi Receipts Detector API](https://developers.mindee.com/docs/python-multi-receipts-detector-ocr)
 
 You can view the source code on [GitHub](https://github.com/mindee/mindee-api-python).
 

docs/extras/guide/bank_account_details_v2.md

@@ -1,5 +1,8 @@
 ---
 title: FR Bank Account Details OCR Python
+category: 622b805aaec68102ea7fcbc2
+slug: python-fr-bank-account-details-ocr
+parentDoc: 609808f773b0b90051d839de
 ---
 The Python OCR SDK supports the [Bank Account Details API](https://platform.mindee.com/mindee/bank_account_details).
 
@@ -25,6 +28,7 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
+
 ```
 
 **Output (RST):**
@@ -70,15 +74,15 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### BasicField
+### BaseField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
 * **value** (`Union[float, str]`): corresponds to the field value. Can be `None` if no value was extracted.
 * **confidence** (`float`): the confidence score of the field prediction.
 * **bounding_box** (`[Point, Point, Point, Point]`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`List[Point]`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`int`): the ID of the page, is `None` when at document-level.
+* **page_id** (`int`): the ID of the page, always `None` when at document-level.
 * **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 > **Note:** A `Point` simply refers to a List of two numbers (`[float, float]`).

docs/extras/guide/bank_check_v1.md

@@ -1,5 +1,8 @@
 ---
 title: US Bank Check OCR Python
+category: 622b805aaec68102ea7fcbc2
+slug: python-us-bank-check-ocr
+parentDoc: 609808f773b0b90051d839de
 ---
 The Python OCR SDK supports the [Bank Check API](https://platform.mindee.com/mindee/bank_check).
 
@@ -25,6 +28,7 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
+
 ```
 
 **Output (RST):**
@@ -70,15 +74,15 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### BasicField
+### BaseField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
 * **value** (`Union[float, str]`): corresponds to the field value. Can be `None` if no value was extracted.
 * **confidence** (`float`): the confidence score of the field prediction.
 * **bounding_box** (`[Point, Point, Point, Point]`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`List[Point]`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`int`): the ID of the page, is `None` when at document-level.
+* **page_id** (`int`): the ID of the page, always `None` when at document-level.
 * **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 > **Note:** A `Point` simply refers to a List of two numbers (`[float, float]`).
@@ -106,7 +110,7 @@ The position field `PositionField` does not implement all the basic `BaseField`
 The text field `StringField` only has one constraint: its **value** is an `Optional[str]`.
 
 ## Page-Level Fields
-Some fields are constrained to the page level, and so will not be retrievable to through the document.
+Some fields are constrained to the page level, and so will not be retrievable at document level.
 
 # Attributes
 The following fields are extracted for Bank Check V1:

docs/extras/guide/barcode_reader_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Barcode Reader OCR Python
+category: 622b805aaec68102ea7fcbc2
+slug: python-barcode-reader-ocr
+parentDoc: 609808f773b0b90051d839de
 ---
 The Python OCR SDK supports the [Barcode Reader API](https://platform.mindee.com/mindee/barcode_reader).
 
@@ -25,6 +28,7 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
+
 ```
 
 **Output (RST):**
@@ -60,15 +64,15 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### BasicField
+### BaseField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
 * **value** (`Union[float, str]`): corresponds to the field value. Can be `None` if no value was extracted.
 * **confidence** (`float`): the confidence score of the field prediction.
 * **bounding_box** (`[Point, Point, Point, Point]`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`List[Point]`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`int`): the ID of the page, is `None` when at document-level.
+* **page_id** (`int`): the ID of the page, always `None` when at document-level.
 * **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 > **Note:** A `Point` simply refers to a List of two numbers (`[float, float]`).

docs/extras/guide/carte_grise_v1.md

@@ -1,5 +1,8 @@
 ---
 title: FR Carte Grise OCR Python
+category: 622b805aaec68102ea7fcbc2
+slug: python-fr-carte-grise-ocr
+parentDoc: 609808f773b0b90051d839de
 ---
 The Python OCR SDK supports the [Carte Grise API](https://platform.mindee.com/mindee/carte_grise).
 
@@ -25,6 +28,7 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
+
 ```
 
 **Output (RST):**
@@ -136,15 +140,15 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### BasicField
+### BaseField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
 * **value** (`Union[float, str]`): corresponds to the field value. Can be `None` if no value was extracted.
 * **confidence** (`float`): the confidence score of the field prediction.
 * **bounding_box** (`[Point, Point, Point, Point]`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`List[Point]`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`int`): the ID of the page, is `None` when at document-level.
+* **page_id** (`int`): the ID of the page, always `None` when at document-level.
 * **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 > **Note:** A `Point` simply refers to a List of two numbers (`[float, float]`).

docs/extras/guide/carte_vitale_v1.md

@@ -1,5 +1,8 @@
 ---
 title: FR Carte Vitale OCR Python
+category: 622b805aaec68102ea7fcbc2
+slug: python-fr-carte-vitale-ocr
+parentDoc: 609808f773b0b90051d839de
 ---
 The Python OCR SDK supports the [Carte Vitale API](https://platform.mindee.com/mindee/carte_vitale).
 
@@ -25,6 +28,7 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
+
 ```
 
 **Output (RST):**
@@ -62,15 +66,15 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### BasicField
+### BaseField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
 * **value** (`Union[float, str]`): corresponds to the field value. Can be `None` if no value was extracted.
 * **confidence** (`float`): the confidence score of the field prediction.
 * **bounding_box** (`[Point, Point, Point, Point]`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`List[Point]`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`int`): the ID of the page, is `None` when at document-level.
+* **page_id** (`int`): the ID of the page, always `None` when at document-level.
 * **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 > **Note:** A `Point` simply refers to a List of two numbers (`[float, float]`).

docs/extras/guide/cli.md

@@ -1,52 +1,58 @@
-## Command Line Usage
+---
+title: Command Line Interface
+category: 622b805aaec68102ea7fcbc2
+slug: python-cli
+parentDoc: 609808f773b0b90051d839de
+---
+# Command Line Usage
 
 The CLI tool is provided mainly for quick tests and debugging.
 
-### General help
+## General help
 
 ```shell
 python3 -m mindee --help
 ```
 
-### Example command help
+## Example command help
 
 ```shell
 python3 -m mindee parse --help
 ```
 
-### Example parse command for Off-the-Shelf document
+## Example parse command for Off-the-Shelf document
 
 ```shell
 python3 -m mindee parse invoice --key xxxxxxx /path/to/invoice.pdf
 ```
 
-### Works with environment variables
+## Works with environment variables
 
 ```shell
 export MINDEE_API_KEY=xxxxxx
 python3 -m mindee parse invoice /path/to/invoice.pdf
 ```
 
-### Example parse command for a custom document
+## Example parse command for a custom document
 
 ```shell
 python3 -m mindee parse custom -a pikachu -k xxxxxxx pokemon_card /path/to/card.jpg
 ```
 
-### Example async parse command
+## Example async parse command
 
 ```shell
 python3 -m mindee parse invoice-splitter 
 ```
 
 
-### Full parsed output
+## Full parsed output
 
 ```shell
 python3 -m mindee invoice -o parsed /path/to/invoice.pdf
 ```
 
-### Running the script through shell
+## Running the script through shell
 
 A helper script allows you to start the command directly:
 

docs/extras/guide/cropper_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Cropper OCR Python
+category: 622b805aaec68102ea7fcbc2
+slug: python-cropper-ocr
+parentDoc: 609808f773b0b90051d839de
 ---
 The Python OCR SDK supports the [Cropper API](https://platform.mindee.com/mindee/cropper).
 
@@ -25,6 +28,7 @@ print(result.document)
 
 # Print the document-level summary
 # print(result.document.inference.prediction)
+
 ```
 
 **Output (RST):**
@@ -56,15 +60,15 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### BasicField
+### BaseField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
 * **value** (`Union[float, str]`): corresponds to the field value. Can be `None` if no value was extracted.
 * **confidence** (`float`): the confidence score of the field prediction.
 * **bounding_box** (`[Point, Point, Point, Point]`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
 * **polygon** (`List[Point]`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`int`): the ID of the page, is `None` when at document-level.
+* **page_id** (`int`): the ID of the page, always `None` when at document-level.
 * **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 > **Note:** A `Point` simply refers to a List of two numbers (`[float, float]`).
@@ -80,7 +84,7 @@ The position field `PositionField` does not implement all the basic `BaseField`
 * **quadrangle** (`[Point, Point, Point, Point]`): a free polygon made up of four points.
 
 ## Page-Level Fields
-Some fields are constrained to the page level, and so will not be retrievable to through the document.
+Some fields are constrained to the page level, and so will not be retrievable at document level.
 
 # Attributes
 The following fields are extracted for Cropper V1:

docs/extras/guide/custom_v1.md

@@ -1,6 +1,11 @@
 ---
-title: Custom API Python
+title: Custom API Python (Deprecated)
+category: 622b805aaec68102ea7fcbc2
+slug: python-api-builder
+parentDoc: 609808f773b0b90051d839de
 ---
+> 🚧 This product is still supported, but is considered to be deprecated. If you are looking for the DocTI API documentation, you can find it [here](https://developers.mindee.com/docs/generated-api-python).
+
 The Python OCR SDK supports [custom-built APIs](https://developers.mindee.com/docs/build-your-first-document-parsing-api).
 If your document isn't covered by one of Mindee's Off-the-Shelf APIs, you can create your own API using the[API Builder](https://platform.mindee.com/api-builder).