From bcc45b5e3f2241f64d3eddf361c30d9441699f71 Mon Sep 17 00:00:00 2001
From: sebastianMindee <130448732+sebastianMindee@users.noreply.github.com>
Date: Mon, 2 Jun 2025 19:06:52 +0200
Subject: [PATCH 1/2] fix typos in md documentation

---
 docs/financial_document_v1.md | 16 ++++++++--------
 docs/invoices_v4.md           | 16 ++++++++--------
 docs/us_mail_v3.md            | 35 +----------------------------------
 3 files changed, 17 insertions(+), 50 deletions(-)

diff --git a/docs/financial_document_v1.md b/docs/financial_document_v1.md
index 0633cf240..457907ca7 100644
--- a/docs/financial_document_v1.md
+++ b/docs/financial_document_v1.md
@@ -241,14 +241,14 @@ Aside from the previous attributes, all basic fields have access to a custom `to
 ### AddressField
 Aside from the basic `BaseField` attributes, the address field `AddressField` also implements the following:
 
-* **streetNumber** (`string`): String representation of the string number. Can be `null`.
-* **streetName** (`string`): Name of the street. Can be `null`.
-* **poBox** (`string`): String representation of the PO Box number. Can be `null`.
-* **addressComplement** (`string`): Address complement. Can be `null`.
-* **city** (`string`): City name. Can be `null`.
-* **postalcode** (`string`): String representation of the postal code. Can be `null`.
-* **state** (`string`): State name. Can be `null`.
-* **country** (`string`): Country name. Can be `null`.
+* **streetNumber** (`String`): String representation of the street number. Can be `null`.
+* **streetName** (`String`): Name of the street. Can be `null`.
+* **poBox** (`String`): String representation of the PO Box number. Can be `null`.
+* **addressComplement** (`String`): Address complement. Can be `null`.
+* **city** (`String`): City name. Can be `null`.
+* **postalcode** (`String`): String representation of the postal code. Can be `null`.
+* **state** (`String`): State name. Can be `null`.
+* **country** (`String`): Country name. Can be `null`.
 
 Note: The `value` field of an AddressField should be a concatenation of the rest of the values.
 
diff --git a/docs/invoices_v4.md b/docs/invoices_v4.md
index d6c64649f..6927bdf49 100644
--- a/docs/invoices_v4.md
+++ b/docs/invoices_v4.md
@@ -233,14 +233,14 @@ Aside from the previous attributes, all basic fields have access to a custom `to
 ### AddressField
 Aside from the basic `BaseField` attributes, the address field `AddressField` also implements the following:
 
-* **streetNumber** (`string`): String representation of the string number. Can be `null`.
-* **streetName** (`string`): Name of the street. Can be `null`.
-* **poBox** (`string`): String representation of the PO Box number. Can be `null`.
-* **addressComplement** (`string`): Address complement. Can be `null`.
-* **city** (`string`): City name. Can be `null`.
-* **postalcode** (`string`): String representation of the postal code. Can be `null`.
-* **state** (`string`): State name. Can be `null`.
-* **country** (`string`): Country name. Can be `null`.
+* **streetNumber** (`String`): String representation of the street number. Can be `null`.
+* **streetName** (`String`): Name of the street. Can be `null`.
+* **poBox** (`String`): String representation of the PO Box number. Can be `null`.
+* **addressComplement** (`String`): Address complement. Can be `null`.
+* **city** (`String`): City name. Can be `null`.
+* **postalcode** (`String`): String representation of the postal code. Can be `null`.
+* **state** (`String`): State name. Can be `null`.
+* **country** (`String`): Country name. Can be `null`.
 
 Note: The `value` field of an AddressField should be a concatenation of the rest of the values.
 
diff --git a/docs/us_mail_v3.md b/docs/us_mail_v3.md
index d2a086b8e..fe10fd296 100644
--- a/docs/us_mail_v3.md
+++ b/docs/us_mail_v3.md
@@ -6,7 +6,7 @@ parentDoc: 631a062c3718850f3519b793
 ---
 The Java OCR SDK supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg) can be used for testing purposes.
 ![US Mail sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg?raw=true)
 
 # Quick-Start
@@ -54,39 +54,6 @@ public class SimpleMindeeClient {
 }
 
 ```
-
-**Output (RST):**
-```rst
-########
-Document
-########
-:Mindee ID: f9c36f59-977d-4ddc-9f2d-31c294c456ac
-:Filename: default_sample.jpg
-
-Inference
-#########
-:Product: mindee/us_mail v3.0
-:Rotation applied: Yes
-
-Prediction
-==========
-:Sender Name: company zed
-:Sender Address:
-  :City: Dallas
-  :Complete Address: 54321 Elm Street, Dallas, Texas 54321
-  :Postal Code: 54321
-  :State: TX
-  :Street: 54321 Elm Street
-:Recipient Names: Jane Doe
-:Recipient Addresses:
-  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
-  | City            | Complete Address                    | Is Address Change | Postal Code | Private Mailbox Number | State | Street                    | Unit            |
-  +=================+=====================================+===================+=============+========================+=======+===========================+=================+
-  | Detroit         | 1234 Market Street PMB 4321, Det... | False             | 12345       | 4321                   | MI    | 1234 Market Street        |                 |
-  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
-:Return to Sender: False
-```
-
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.

From d12e2a2853d6008d28a3aa6044b8794804b7e0a8 Mon Sep 17 00:00:00 2001
From: sebastianMindee <130448732+sebastianMindee@users.noreply.github.com>
Date: Tue, 3 Jun 2025 09:39:31 +0200
Subject: [PATCH 2/2] fix missing rst sample in us mail v3 doc

---
 docs/us_mail_v3.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/docs/us_mail_v3.md b/docs/us_mail_v3.md
index fe10fd296..d2a086b8e 100644
--- a/docs/us_mail_v3.md
+++ b/docs/us_mail_v3.md
@@ -6,7 +6,7 @@ parentDoc: 631a062c3718850f3519b793
 ---
 The Java OCR SDK supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg) can be used for testing purposes.
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![US Mail sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg?raw=true)
 
 # Quick-Start
@@ -54,6 +54,39 @@ public class SimpleMindeeClient {
 }
 
 ```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: f9c36f59-977d-4ddc-9f2d-31c294c456ac
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/us_mail v3.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Sender Name: company zed
+:Sender Address:
+  :City: Dallas
+  :Complete Address: 54321 Elm Street, Dallas, Texas 54321
+  :Postal Code: 54321
+  :State: TX
+  :Street: 54321 Elm Street
+:Recipient Names: Jane Doe
+:Recipient Addresses:
+  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
+  | City            | Complete Address                    | Is Address Change | Postal Code | Private Mailbox Number | State | Street                    | Unit            |
+  +=================+=====================================+===================+=============+========================+=======+===========================+=================+
+  | Detroit         | 1234 Market Street PMB 4321, Det... | False             | 12345       | 4321                   | MI    | 1234 Market Street        |                 |
+  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
+:Return to Sender: False
+```
+
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.