diff --git a/.mintignore b/.mintignore new file mode 100644 index 0000000..34472b6 --- /dev/null +++ b/.mintignore @@ -0,0 +1 @@ +reviews/* diff --git a/README.md b/README.md index 6ba1141..c56514c 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,10 @@ For the highest quality documentation, use both the diataxis plugin and docs-rev This two-pass approach ensures both structural correctness (via diataxis) and editorial quality (via docs-reviewer). +3. **Check for broken links:** + +Finally, you can run `mint broken-links` and `mint broken-links --check-anchors` to ensure all links are correct. + ### Future Plans - Add a subagent to search our codebase and backstage diff --git a/api-reference/translate.mdx b/api-reference/translate.mdx index 0e3f739..5e3284c 100644 --- a/api-reference/translate.mdx +++ b/api-reference/translate.mdx @@ -9,7 +9,7 @@ The text-translation API currently consists of a single endpoint, `translate`, w 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). -To learn more about context in DeepL API translations, see our [context parameter guide](/docs/learning-how-tos/how-to-use-context-parameter). +To learn more about context in DeepL API translations, see our [context parameter guide](/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter). For more detail about request body parameters, see the [Request Body Descriptions](/api-reference/translate#request-body-descriptions) section further down on the page. diff --git a/docs.json b/docs.json index ad046dd..325e9b7 100644 --- a/docs.json +++ b/docs.json @@ -399,11 +399,11 @@ }, { "source": "/docs/best-practices/working-with-context", - "destination": "/docs/learning-how-tos/how-to-use-context-parameter" + "destination": "/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter" }, { "source": "/docs/learning-how-tos/cookbook/context-parameter-examples", - "destination": "/docs/learning-how-tos/how-to-use-context-parameter" + "destination": "/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter" } ], "integrations": { diff --git a/docs/best-practices/custom-instructions.mdx b/docs/best-practices/custom-instructions.mdx index 2138d87..a7c78d8 100644 --- a/docs/best-practices/custom-instructions.mdx +++ b/docs/best-practices/custom-instructions.mdx @@ -94,6 +94,6 @@ Combining `custom_instructions` with `model_type: latency_optimized` will result ## Related documentation - [Text translation API reference](/api-reference/translate) -- [Working with context](/docs/examples-and-guides/how-to-use-context-parameter) +- [Working with context](/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter) - [Style rules API](/api-reference/style-rules) - [Multilingual glossaries](/api-reference/multilingual-glossaries) diff --git a/docs/best-practices/pre-production-checklist.mdx b/docs/best-practices/pre-production-checklist.mdx index bbab7a0..645806f 100644 --- a/docs/best-practices/pre-production-checklist.mdx +++ b/docs/best-practices/pre-production-checklist.mdx @@ -11,5 +11,5 @@ As you prepare to open your DeepL-powered application up to the world, these tip * Uploading a file for document translation requires an HTTP POST request with `Content-Type: multipart/form-data`; this content type should not be used for text translation. 4. **No query parameters:** Please do not make API requests using query parameters. The examples throughout the API reference include properly formed HTTP POST requests. For security reasons, be especially sure not to send your authentication key via query parameters. 5. **CORS requests:** It's not possible to send requests to the DeepL API from the browser, as requests to third-party APIs from front-end applications would expose your credentials on the web. [You can learn more here](/docs/best-practices/cors-requests). -6. **Translation context:** DeepL considers the broader context of a source text or document when translating. In general, including more context in a source text or document can result in a higher-quality DeepL translation. For text translation, you can also try the [`context` parameter](/api-reference/translate#request-body-descriptions). [Learn more about working with context here](/docs/best-practices/working-with-context). +6. **Translation context:** DeepL considers the broader context of a source text or document when translating. In general, including more context in a source text or document can result in a higher-quality DeepL translation. For text translation, you can also try the [`context` parameter](/api-reference/translate#request-body-descriptions). [Learn more about working with context here](/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter). 7. **Cache results from translation requests:** Storing API responses lets apps serve content faster and avoids extra costs from repeated requests for unchanged content. diff --git a/docs/learning-how-tos/examples-and-guides/translating-between-variants.mdx b/docs/learning-how-tos/examples-and-guides/translating-between-variants.mdx index 6ecd1d5..3f23d6e 100644 --- a/docs/learning-how-tos/examples-and-guides/translating-between-variants.mdx +++ b/docs/learning-how-tos/examples-and-guides/translating-between-variants.mdx @@ -130,5 +130,5 @@ Now that you understand how to translate between language variants: - **Try it yourself:** Test out style rules and custom instructions in the [text translation API playground](/api-reference/translate) - **Learn about the Write API:** Explore the [/write/rephrase endpoint](/api-reference/improve-text) for high-quality variant translation and rephrasing - **Manage reusable rules:** Learn how to create [style rules](/api-reference/style-rules) for systematic variant transformations -- **Improve translation quality:** Understand how [the context parameter](/docs/best-practices/working-with-context) can enhance ambiguous translations +- **Improve translation quality:** Understand how [the context parameter](/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter) can enhance ambiguous translations