diff --git a/README.md b/README.md index 0c0853f0..de1d6578 100644 --- a/README.md +++ b/README.md @@ -79,8 +79,9 @@ var prediction = await _mindeeClient There's more to it than that for those that need more features, or want to customize the experience. -All the juicy details are described in the -**[Official Guide](https://developers.mindee.com/docs/dotnet-ocr-sdk)**. +All the juicy details are described in the **[Official Guide](docs/index.md)**. + +You also can use the **[Reference documentation](docs/api-reference/Mindee/index.md)** to dig deeper in the code. ## License Copyright © Mindee diff --git a/docs/api-reference/Mindee/_config.yml b/docs/api-reference/Mindee/_config.yml new file mode 100644 index 00000000..761ed8f4 --- /dev/null +++ b/docs/api-reference/Mindee/_config.yml @@ -0,0 +1,3 @@ +source: docs +highlighter: rouge +markdown: GFM diff --git a/docs/dotnet-getting-started.md b/docs/dotnet-getting-started.md index 411d3c2b..dede7ac8 100644 --- a/docs/dotnet-getting-started.md +++ b/docs/dotnet-getting-started.md @@ -202,10 +202,10 @@ _logger.Debug(prediction.Inference.Prediction.ToString()); ``` The various attributes are detailed in these document-specific guides: -* [Invoice](https://developers.mindee.com/docs/dotnet-invoice-ocr) -* [Receipt](https://developers.mindee.com/docs/dotnet-receipt-ocr) -* [Passport](https://developers.mindee.com/docs/dotnet-passport-ocr) -* [custom-built API](https://developers.mindee.com/docs/dotnet-api-builder) +* [Invoice](dotnet-invoice-ocr.md) +* [Receipt](dotnet-receipt-ocr.md) +* [Passport](dotnet-passport-ocr.md) +* [custom-built API](dotnet-api-builder.md) #### Page level prediction The `pages` attribute is a list of `prediction` object of the same class as the [`prediction` attribute](#document-level-prediction). diff --git a/docs/index.md b/docs/index.md index f6bfd7cf..05bb993f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,12 +46,12 @@ var prediction = await _mindeeClient ``` Complete details on the working of the library are available in the following guides: -* [Overview](https://developers.mindee.com/docs/dotnet-overview-1) -* [.NET Custom APIs OCR](https://developers.mindee.com/docs/dotnet-api-builder-1) -* [.NET invoices OCR](https://developers.mindee.com/docs/dotnet-invoice-ocr-1) -* [.NET receipts OCR](https://developers.mindee.com/docs/dotnet-receipt-ocr-1) -* [.NET passports OCR](https://developers.mindee.com/docs/dotnet-passport-ocr-1) -* [Mindee API Reference](https://github.com/mindee/mindee-api-dotnet/blob/main/docs/api-reference/Mindee) +* [Overview](dotnet-getting-started.md) +* [.NET Custom APIs OCR](dotnet-api-builder.md) +* [.NET invoices OCR](dotnet-invoice-ocr.md) +* [.NET receipts OCR](dotnet-receipt-ocr.md) +* [.NET passports OCR](dotnet-passport-ocr.md) +* [.NET API Reference](api-reference/Mindee/index.md) You can view the source code on [GitHub](https://github.com/mindee/mindee-api-dotnet).