Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion docfx/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@
/**/bin/
/**/obj/
_exported_templates
_site
_site
*.yml
.manifest
49 changes: 17 additions & 32 deletions docfx/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,18 @@
{
"src": [
{
"files": [
"**/Textkernel.Tx.SDK/**.csproj"
],
"src": "../src"
"files": ["**/Textkernel.Tx.SDK/**.csproj"],
"src": "../src"
}
],
"dest": "sdk",
"disableGitFeatures": false,
"disableDefaultFilter": false
"dest": ".",
"namespaceLayout": "Nested"
}
],
"build": {
"content": [
{
"files": [
"sdk/**.yml",
"sdk/index.md"
]
},
{
"files": [
"toc.yml",
"*.md"
]
"files": "**/*.{md,yml}"
}
],
"resource": [
Expand All @@ -36,25 +24,22 @@
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"globalMetadata": {
"_disableContribution": "true",
"_appFaviconPath": "images/favicon.svg",
"_appLogoPath": "images/logo.png",
"_appTitle": "Textkernel SDK",
"_appName": "Textkernel Tx Platform .NET SDK",
"_enableSearch": true,
"_disableToc": false,
"_disableAffix": false,
"_disableNavbar": false
},
"template": [
"default",
"templates/darkfx"
"modern"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
Expand Down
Binary file removed docfx/images/favicon.ico
Binary file not shown.
65 changes: 65 additions & 0 deletions docfx/images/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docfx/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 29 additions & 2 deletions docfx/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
# tx-dotnet
Return to the project main page on GitHub [here][gh-url]
# Textkernel Tx .NET SDK Documentation
This is the auto-generated (by [DocFX](https://dotnet.github.io/docfx/)) documentation for the SDK codebase.
If you were looking for best-practices, transaction costs, or other API documentation, you
can find that [here](https://developer.textkernel.com/tx-platform/v10/overview/).

You can also go back to the [GitHub project page](https://github.com/textkernel/tx-dotnet) for more usage information and examples.

## Basics
- @"Textkernel.Tx.TxClient" - the core class of the SDK. It is used to make all of the API calls.
- @"Textkernel.Tx.DataCenter" - used to point the @"Textkernel.Tx.TxClient" at the correct data center for your account.
- @"Textkernel.Tx.TxException" - the @"Textkernel.Tx.TxClient" will throw these during normal operations, for example, when you try to parse a resume that is a scanned image. See the GitHub project page for more information and examples.

## Services
- @"Textkernel.Tx.TxClient.Parser" - provides all parsing functionality.
- @"Textkernel.Tx.TxClient.Geocoder" - determines geocoordinates based on addresses.
- @"Textkernel.Tx.TxClient.Formatter" - transforms a parsed resume into a standard/templated format.
- @"Textkernel.Tx.TxClient.SkillsIntelligence" - provides all Skills Intelligence functionality.
- @"Textkernel.Tx.TxClient.SearchMatchV1" - provides all Search & Match V1 functionality.
- @"Textkernel.Tx.TxClient.SearchMatchV2" - provides all Search & Match V2 functionality.

## Core Models
- @"Textkernel.Tx.Models.Document" - represents an unparsed resume/job, such as a file on the file system or a byte[] in a database. This is what you pass to the @"Textkernel.Tx.TxClient" for parsing.
- @"Textkernel.Tx.Models.Resume.ParsedResume" - contains all of the properties/information that is extracted when a resume/cv is parsed.
- @"Textkernel.Tx.Models.Job.ParsedJob" - contains all of the properties/information that is extracted when a job description is parsed.
- @"Textkernel.Tx.Models.API.ApiResponseInfo" - returned with every API call, this contains information about the transaction (error messages, cost, duration, account information, etc).





[gh-url]: https://github.com/textkernel/tx-dotnet/
5 changes: 0 additions & 5 deletions docfx/sdk/.gitignore

This file was deleted.

27 changes: 0 additions & 27 deletions docfx/sdk/index.md

This file was deleted.

40 changes: 0 additions & 40 deletions docfx/templates/darkfx/partials/affix.tmpl.partial

This file was deleted.

29 changes: 0 additions & 29 deletions docfx/templates/darkfx/partials/footer.tmpl.partial

This file was deleted.

20 changes: 0 additions & 20 deletions docfx/templates/darkfx/partials/head.tmpl.partial

This file was deleted.

17 changes: 0 additions & 17 deletions docfx/templates/darkfx/partials/logo.tmpl.partial

This file was deleted.

Loading