Skip to content

📝 Publish technical documentation on GitHub pages #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 22, 2022
Merged

📝 Publish technical documentation on GitHub pages #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9e60843
trying something with jekyll config
Kvindee Nov 21, 2022
fac3399
use local link to referes others pages
Kvindee Nov 21, 2022
d58a3ca
docs
Kvindee Nov 22, 2022
77546b9
docs: adding api reference in the readme
Kvindee Nov 22, 2022
9c884cc
docs: make prettier
Kvindee Nov 22, 2022
567f53b
docs
Kvindee Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/api-reference/Mindee/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
source: docs
highlighter: rouge
markdown: GFM
8 changes: 4 additions & 4 deletions docs/dotnet-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
12 changes: 6 additions & 6 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down