Skip to content

Commit 25f667f

Browse files
authored
Merge pull request #220 from DeepLcom/199-improve-docs-for-context-param
add in new context parameter guide
2 parents e9a1f7a + ee3c260 commit 25f667f

6 files changed

Lines changed: 305 additions & 150 deletions

File tree

api-reference/translate.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The text-translation API currently consists of a single endpoint, `translate`, w
99

1010
For highest translation quality, we recommend using our next-gen models. For details, please see [here](/docs/api-reference/translate#about-the-model-type-parameter).
1111

12-
To learn more about context in DeepL API translations, we recommend [this article](/docs/best-practices/working-with-context).
12+
To learn more about context in DeepL API translations, see our [context parameter guide](/docs/learning-how-tos/how-to-use-context-parameter).
1313

1414
For more detail about request body parameters, see the [Request Body Descriptions](/api-reference/translate#request-body-descriptions) section further down on the page.
1515

docs.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@
5555
"pages": [
5656
"docs/learning-how-tos/cookbook",
5757
"docs/learning-how-tos/cookbook/google-sheets",
58-
"docs/learning-how-tos/cookbook/context-parameter-examples",
5958
"docs/learning-how-tos/cookbook/automating-indie-game-localization-with-the-deepl-api-and-godot",
6059
"docs/learning-how-tos/cookbook/java-document-translator",
6160
"docs/learning-how-tos/cookbook/usage-analytics-dashboard"
@@ -65,6 +64,7 @@
6564
"group": "Guides",
6665
"pages": [
6766
"docs/learning-how-tos/examples-and-guides/",
67+
"docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter",
6868
"docs/learning-how-tos/examples-and-guides/placeholder-tags",
6969
"docs/learning-how-tos/examples-and-guides/first-things-to-try-with-the-deepl-api",
7070
"docs/learning-how-tos/examples-and-guides/glossaries-in-the-real-world",
@@ -79,7 +79,6 @@
7979
"docs/best-practices/error-handling",
8080
"docs/best-practices/cors-requests",
8181
"docs/best-practices/document-translations",
82-
"docs/best-practices/working-with-context",
8382
"docs/best-practices/language-detection",
8483
"docs/best-practices/cost-control",
8584
"docs/best-practices/pre-production-checklist"
@@ -394,6 +393,14 @@
394393
{
395394
"source": "/api-reference/voice/reconnect-stream",
396395
"destination": "/api-reference/voice/reconnect-session"
396+
},
397+
{
398+
"source": "/docs/best-practices/working-with-context",
399+
"destination": "/docs/learning-how-tos/how-to-use-context-parameter"
400+
},
401+
{
402+
"source": "/docs/learning-how-tos/cookbook/context-parameter-examples",
403+
"destination": "/docs/learning-how-tos/how-to-use-context-parameter"
397404
}
398405
],
399406
"integrations": {

docs/best-practices/working-with-context.mdx

Lines changed: 0 additions & 58 deletions
This file was deleted.

docs/learning-how-tos/cookbook/context-parameter-examples.mdx

Lines changed: 0 additions & 88 deletions
This file was deleted.

docs/learning-how-tos/examples-and-guides.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Guides"
33
sidebarTitle: "Overview"
4-
description: "A collection of guides for addressing common issues with the DeepL API."
4+
description: "Learn how to use DeepL API features to achieve your translation goals."
55
public: true
66
---
77
<CardGroup cols={2}>
@@ -18,5 +18,8 @@ public: true
1818

1919
Written by [Akash Joshi](https://thewriting.dev)
2020

21+
</Card>
22+
<Card title="How to Use the Context Parameter Effectively" horizontal href="/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter">
23+
2124
</Card>
2225
</CardGroup>

0 commit comments

Comments
 (0)