📝 improve documentation

Author: Kvindee

docs/java-api-builder.md

@@ -6,6 +6,8 @@ For the following examples, we are using our own [W9s custom API](https://develo
 ## Quick Start
 
 ```java
+String path = "/path/to/the/file.ext";
+DocumentToParse documentToParse = new DocumentToParse(new File(path));
 CustomEndpoint myEndpoint = new CustomEndpoint(
     "wnine",
     "john",
@@ -28,7 +30,7 @@ You have two different ways to parse a custom document.
 1. Use the default one (named ``CustomPrediction``):
 ```java
 
-String path = "/my/path/myfile.ext";
+String path = "/path/to/the/file.ext";
 DocumentToParse documentToParse = new DocumentToParse(new File(path));
 CustomEndpoint myEndpoint = new CustomEndpoint(
     "wnine",
@@ -60,15 +62,16 @@ public class WNineV1Inference
   extends Inference Inference<WNineV1DocumentPrediction, WNineV1DocumentPrediction> {
 }
 
-String path = "/my/path/myfile.ext";
+String path = "/path/to/the/file.ext";
 DocumentToParse documentToParse = new DocumentToParse(new File(path));
 
 Document<WNineV1Inference> myCustomDocument = mindeeClient
     .parse(WNineV1Inference.class, documentToParse);
 ```
 
 ## CustomV1Inference object
-All the fields which are defined in the API builder when creating your custom document, are available.
+All the fields which are present in the API builder 
+are available (the fields are defined when creating your custom API).
 
 `CustomV1Inference` is an object which contains a document prediction and pages prediction result.
 ### `CustomV1PagePrediction` 
@@ -92,7 +95,7 @@ A Map with the following structure:
 In the examples below we'll use the `employer_id` field.
 
 ```java
-String path = "/my/path/myfile.ext";
+String path = "/path/to/the/file.ext";
 DocumentToParse documentToParse = new DocumentToParse(new File(path));
 
 Document<WNineV1Inference> myCustomDocument = mindeeClient

docs/java-getting-started.md

@@ -186,8 +186,9 @@ Regroup the prediction on all the pages of the document and the prediction for a
 * `pages` — [Page level prediction](#page-level-prediction)
 
 #### Document Level Prediction
-The Response object for each document type has an attribute that represents data extracted from the entire document. It's possible to have the same field in various pages, but at the document level only the highest confidence field data will be shown (this is all done automatically at the API level).
-
+The Response object for each document type has an attribute that represents data extracted from the entire document.
+It's possible to have the same field in various pages, but at the document level only the highest confidence field data 
+will be shown (this is all done automatically at the API level).
 
 ```java
 Document<InvoiceV4Inference> invoiceDocument = 
@@ -203,12 +204,12 @@ logger.info(invoiceResponse.documentPrediction.toString());
 
 ```
 
-Each inference specific class will have its own specific attributes, which correspond to the various fields extracted from the document.
+Each inference specific class will have its own specific attributes, these correspond to the various fields extracted from the document.
 
 
 #### Page Level Prediction
-The `pagesPrediction` attribute is a list of `prediction` object, often of the same class as the [`documentPrediction` attribute](#document-level-prediction).
-But sometimes, it could have a different class which will extends the `documentPrediction` class.
+The `pagesPrediction` attribute is a list of `prediction` objects, often of the same class as the [`documentPrediction` attribute](#document-level-prediction).
+But sometimes, it could have a different class which would extend the `documentPrediction` class.
 
 Each page element contains the data extracted for a particular page of the document.
 

docs/java-invoice-ocr.md

@@ -16,7 +16,7 @@ Document<InvoiceV4Inference> invoiceDocument = mindeeClient.parse(InvoiceV4Infer
 // Print a summary of the parsed data
 logger.info(invoiceDocument.toString());
 ```
-
+Output:
 ```rst
 ########
 Document
@@ -232,7 +232,7 @@ invoiceDocument.getInference().getDocumentPrediction().getSupplierPaymentDetails
 
 ### Line items
 
-**`LineItems`** (List<InvoiceLineItem>):  Line items details. Each object in the list contains :
+**`LineItems`** (List<InvoiceLineItem>):  Line items details. Each object in the list contains:
 * `productCode` (String)
 * `description` (String)
 * `quantity` (Double)

docs/java-license-plates-ocr.md

@@ -1,4 +1,4 @@
-The JAVA SDK OCR SDK supports the  API  [Licenses plate OCR](https://developers.mindee.com/docs/license-plates-ocr-nodejs)  for extracting data from pictures (or documents) of cars.
+The JAVA SDK OCR SDK supports the [Licenses plate OCR API](https://developers.mindee.com/docs/license-plates-ocr-nodejs)  for extracting license plates from pictures (or documents) of vehicles.
 
 Using this [sample photo](https://files.readme.io/ffc127d-sample_receipt.jpg) below, we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![sample receipt](https://files.readme.io/fd6086e-license_plate.jpg)
@@ -9,7 +9,7 @@ Using this [sample photo](https://files.readme.io/ffc127d-sample_receipt.jpg) be
 MindeeClient client = MindeeClientInit.create("<your mindee api key>");
 
 // Load a file from disk and parse it
-DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./a74eaa5-c8e283b-sample_invoice.jpeg"));
+DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./fd6086e-license_plate.jpg"));
 Document<LicensePlatesV1Inference> licensePlatesDocument =
  mindeeClient.parse(LicensePlatesV1Inference.class, documentToParse);
 

docs/java-passport-ocr.md

@@ -9,7 +9,7 @@ Using this [sample passport](https://files.readme.io/4a16b1d-passport_pic.jpg) b
 MindeeClient client = MindeeClientInit.create("<your mindee api key>");
 
 // Load a file from disk and parse it
-DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./a74eaa5-c8e283b-sample_invoice.jpeg"));
+DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./4a16b1d-passport_pic.jpg"));
 Document<PassportV1Inference> passportDocument =
  mindeeClient.parse(PassportV1Inference.class, documentToParse);
 

docs/java-receipt-ocr.md

@@ -1,4 +1,4 @@
-The .NET OCR SDK supports the [receipt API](https://developers.mindee.com/docs/receipt-ocr) for extracting data from receipts.
+The JAVA OCR SDK supports the [receipt API](https://developers.mindee.com/docs/receipt-ocr) for extracting data from receipts.
 
 Using this [sample receipt](https://files.readme.io/ffc127d-sample_receipt.jpg) below, we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![sample receipt](https://files.readme.io/ffc127d-sample_receipt.jpg)
@@ -9,7 +9,7 @@ Using this [sample receipt](https://files.readme.io/ffc127d-sample_receipt.jpg)
 MindeeClient client = MindeeClientInit.create("<your mindee api key>");
 
 // Load a file from disk and parse it
-DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./a74eaa5-c8e283b-sample_invoice.jpeg"));
+DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./ffc127d-sample_receipt.jpg"));
 Document<ReceiptV4Inference> receiptDocument =
  mindeeClient.parse(ReceiptV4Inference.class, documentToParse);
 

docs/java-shipping-containers-ocr.md

@@ -1,4 +1,4 @@
-The JAVA OCR SDK supports the  API  [Shipping containers OCR](https://developers.mindee.com/docs/shipping-containers-ocr) for extracting data from pictures of containers identification.
+The JAVA OCR SDK supports the [Shipping containers OCR API](https://developers.mindee.com/docs/shipping-containers-ocr) for extracting data from pictures of containers identification.
 
 Using this [sample](https://files.readme.io/853f15a-shipping_containers.jpg) below, we are going to illustrate how to extract the data that we want using the OCR SDK.
 ![sample](https://files.readme.io/853f15a-shipping_containers.jpg)
@@ -9,7 +9,7 @@ Using this [sample](https://files.readme.io/853f15a-shipping_containers.jpg) bel
 MindeeClient client = MindeeClientInit.create("<your mindee api key>");
 
 // Load a file from disk and parse it
-DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./a74eaa5-c8e283b-sample_invoice.jpeg"));
+DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./853f15a-shipping_containers.jpg"));
 Document<ShippingContainerV1Inference> shippingContainersDocument =
  mindeeClient.parse(ShippingContainerV1Inference.class, documentToParse);
 

docs/java-us-bank-check-ocr.md

@@ -1,12 +1,12 @@
-The .NET OCR SDK supports the [Bank Checks OCR](https://developers.mindee.com/docs/bank-check-ocr) for extracting data from bank checks.
+The JAVA OCR SDK supports the [Bank Checks OCR API](https://developers.mindee.com/docs/bank-check-ocr) for extracting data from bank checks.
 
 ## Quick Start
 ```java
 // Init a new client
 MindeeClient client = MindeeClientInit.create("<your mindee api key>");
 
 // Load a file from disk and parse it
-DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./a74eaa5-c8e283b-sample_invoice.jpeg"));
+DocumentToParse documentToParse = mindeeClient.loadDocument(new File("./path/to/the/file.ext"));
 Document<BankCheckV1Inference> bankCheckDocument =
  mindeeClient.parse(BankCheckV1Inference.class, documentToParse);