Merge pull request #165 from DeepLcom/client-libraries

Move client libraries to "Getting Started", tweak content
Include redirect from old location, update all links

Author: morsssss

api-reference/document.mdx

@@ -301,7 +301,7 @@ Content-Type: application/json
 
 The examples on this page show how to translate documents with DeepL using the API directly.
 
-DeepL's [client libraries](/api-reference/client-libraries) simplify API document translation by providing a convenience function to upload the document, check translation status and download the translated document with a single function call.
+DeepL's [client libraries](/docs/getting-started/client-libraries) simplify API document translation by providing a convenience function to upload the document, check translation status and download the translated document with a single function call.
 
 ### Document format conversions
 

docs.json

@@ -40,6 +40,7 @@
               "docs/getting-started/intro",
               "docs/getting-started/about",
               "docs/getting-started/auth",
+              "docs/getting-started/client-libraries",
               "docs/getting-started/managing-api-keys",
               "docs/getting-started/your-first-api-request",
               "docs/getting-started/test-your-api-requests-with-postman",
@@ -206,10 +207,6 @@
                   "api-reference/admin-api/organization-usage-analytics",
                   "api-reference/admin-api/get-usage-analytics"
                 ]
-              },
-              {
-                "group": "Client libraries",
-                "pages": ["api-reference/client-libraries"]
               }
             ]
           }
@@ -372,6 +369,10 @@
       "source": "/docs/resources/release-notes",
       "destination": "/docs/resources/roadmap-and-release-notes"
     },
+    {
+      "source": "/api-reference/client-libraries",
+      "destination": "/docs/getting-started/client-libraries"
+    },
     {
       "source": "/docs/resources/release-notes/rss.xml",
       "destination": "/docs/resources/roadmap-and-release-notes/rss.xml"

docs/best-practices/cors-requests.mdx

@@ -11,4 +11,4 @@ If you realize your API authentication key has been compromised, log in to your
 
 To safely use the DeepL API on your website or application, you can route your requests through your own backend servers. This keeps your credentials hidden and allows you to specify CORS policies and rate limits as required by your use case.
 
-DeepL's official open-source [client libraries](/api-reference/client-libraries) can help you create these backend implementations.
+DeepL's official open-source [client libraries](/docs/getting-started/client-libraries) can help you create these backend implementations.

docs/best-practices/error-handling.mdx

@@ -5,11 +5,11 @@ public: true
 
 Errors are indicated by [standard HTTP status codes](https://developer.mozilla.org/docs/Web/HTTP/Status). It is important to make sure that your application handles errors in an appropriate way. To that end, please consult the list of expected status code results that are provided with each endpoint's documentation in the API Reference.
 
-* **HTTP 429: too many requests.** This is an error that you might receive when sending many API requests in a short period of time. Your application should be configured to resend the requests after some delay. Specifically, we recommend implementing retries with exponential backoff. This is implemented in all of the official, DeepL-supported [client libraries](/api-reference/client-libraries).
+* **HTTP 429: too many requests.** This is an error that you might receive when sending many API requests in a short period of time. Your application should be configured to resend the requests after some delay. Specifically, we recommend implementing retries with exponential backoff. This is implemented in all of the official, DeepL-supported [client libraries](/docs/getting-started/client-libraries).
 
 * **HTTP 456: quota exceeded** **If you're a Free API user**, you'll receive this error when the monthly 500,000 character limit of your subscription has been reached. You can consider [upgrading your subscription](https://www.deepl.com/pro) if you need more character volume. **If you're a Pro API user**, you'll receive this error when your [Cost Control](/docs/best-practices/cost-control)limit has been reached, and you can increase or remove your Cost Control limit if you need to continue translating. You can also use the [usage endpoint](/api-reference/usage-and-quota) to find out your currently used and available quota.
 
-* **HTTP 500: internal server error** This is an error you'll receive if there are temporary errors in DeepL Services. Your application should be configured to resend the requests after some delay. Specifically, we recommend implementing retries with exponential backoff. This is implemented in all of the official, DeepL-supported [client libraries](/api-reference/client-libraries).
+* **HTTP 500: internal server error** This is an error you'll receive if there are temporary errors in DeepL Services. Your application should be configured to resend the requests after some delay. Specifically, we recommend implementing retries with exponential backoff. This is implemented in all of the official, DeepL-supported [client libraries](/docs/getting-started/client-libraries).
 
 The service dynamically adjusts to the load on the system. Please wait to stop receiving errors to send more requests again. As the service adapts, you will be able to send increasingly more requests within a given amount of time without encountering errors.
 

docs/best-practices/pre-production-checklist.mdx

@@ -5,8 +5,8 @@ public: true
 ---
 As you prepare to open your DeepL-powered application up to the world, these tips will help you get ready for production.
 
-1. **Error handling:** If you receive 429 or 500 errors, use retries with exponential backoff. If you use one of [DeepL's official client libraries](/api-reference/client-libraries), you get this functionality out-of-the-box.
-2. **Persistent HTTP connection:** Especially for use cases with low latency requirements, we recommend using a persistent HTTP connection. [DeepL's official client libraries](/api-reference/client-libraries) use [Keep-Alive](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Keep-Alive) by default.
+1. **Error handling:** If you receive 429 or 500 errors, use retries with exponential backoff. If you use one of [DeepL's official client libraries](/docs/getting-started/client-libraries), you get this functionality out-of-the-box.
+2. **Persistent HTTP connection:** Especially for use cases with low latency requirements, we recommend using a persistent HTTP connection. [DeepL's official client libraries](/docs/getting-started/client-libraries) use [Keep-Alive](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Keep-Alive) by default.
 3. **Use the correct content type:** For text translation (the `/translate` endpoint), use form-encoded (`Content-Type: application/x-www-form-urlencoded`) or JSON-encoded (`Content-Type: application/json`) request bodies.
    * 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.

api-reference/client-libraries.mdx docs/getting-started/client-libraries.mdxapi-reference/client-libraries.mdx renamed to docs/getting-started/client-libraries.mdx

@@ -1,20 +1,10 @@
 ---
 title: "Client libraries"
 public: true
-sidebarTitle: "Overview"
 ---
+## Official client libraries
 
-Client library features include but are not limited to:
-
-* Out-of-the-box retries with exponential backoff for correct handling of 429 and 500 errors
-* Persistent HTTP connection (keep-alive) enabled by default
-* All document translation steps (upload, check status, and download) consolidated into a single convenience function
-
-All officially supported client libraries, which you can find in the [DeepL Github Organization](https://github.com/DeepLcom/), are open source under the MIT License.
-
-Please note that the Ruby client library is still under development and is not yet fully supported by DeepL. We will update this page when development work is complete!
-
-We welcome feedback in the form of issues and pull requests!
+DeepL develops and supports client libraries for six popular languages:
 
 <CardGroup cols={2}>
   <Card title="DeepL .NET Library" horizontal href="https://www.github.com/deeplcom/deepl-dotnet">
@@ -35,4 +25,17 @@ We welcome feedback in the form of issues and pull requests!
   <Card title="DeepL Java Library" horizontal href="https://www.github.com/deeplcom/deepl-java">
   deeplcom\deepl-java
   </Card>
-</CardGroup>
+</CardGroup>
+
+Features include:
+
+* Out-of-the-box retries with exponential backoff for correct handling of 429 and 500 errors
+* Persistent HTTP connection (keep-alive) enabled by default
+* All document translation steps (upload, check status, and download) consolidated into a single convenience function
+
+All officially supported client libraries are open-source under the MIT License. We welcome feedback in the form of issues and pull requests!
+
+## Community-created client libraries
+
+The DeepL community [maintains client libraries](https://github.com/DeepLcom/awesome-deepl?tab=readme-ov-file#community-libraries--sdks) for other languages, including [Dart](https://github.com/komape/deepl_dart), [Go](https://github.com/candy12t/go-deepl), [Rust](https://github.com/Avimitin/deepl-rs), and [Kotlin](https://github.com/SimplyMika/DeeplKt).
+

docs/getting-started/intro.mdx

@@ -23,7 +23,7 @@ New user? Follow these quick steps to get started with the DeepL API.
     Find your API key [here](https://www.deepl.com/your-account/keys).
      Then try making a simple translation request in one of these ways:
     * cURL or an HTTP request
-    * with [our client libraries](/api-reference/client-libraries) for [Python](https://www.github.com/deeplcom/deepl-python), [JavaScript](https://www.github.com/deeplcom/deepl-node), [PHP](https://www.github.com/deeplcom/deepl-php), [.NET](https://www.github.com/deeplcom/deepl-dotnet), [Java](https://www.github.com/deeplcom/deepl-java), or [Ruby](https://www.github.com/deeplcom/deepl-rb)
+    * with [our client libraries](/docs/getting-started/client-libraries) for [Python](https://www.github.com/deeplcom/deepl-python), [JavaScript](https://www.github.com/deeplcom/deepl-node), [PHP](https://www.github.com/deeplcom/deepl-php), [.NET](https://www.github.com/deeplcom/deepl-dotnet), [Java](https://www.github.com/deeplcom/deepl-java), or [Ruby](https://www.github.com/deeplcom/deepl-rb)
     * [in our playground](https://developers.deepl.com/api-reference/translate/request-translation?playground=open)
     * [in Postman](/docs/getting-started/test-your-api-requests-with-postman)
 
@@ -239,7 +239,7 @@ New user? Follow these quick steps to get started with the DeepL API.
     </Tabs>
   </Step>
   <Step title="Step 3: Keep building with our client libraries and how-to guides" titleSize="h3">
-    [Our official client libraries](/api-reference/client-libraries) let you use the API with six popular programming languages - [Python](https://www.github.com/deeplcom/deepl-python), [JavaScript](https://www.github.com/deeplcom/deepl-node), [PHP](https://www.github.com/deeplcom/deepl-php), [.NET](https://www.github.com/deeplcom/deepl-dotnet), [Java](https://www.github.com/deeplcom/deepl-java), or [Ruby](https://www.github.com/deeplcom/deepl-rb). The DeepL community has [contributed client libraries](https://github.com/DeepLcom/awesome-deepl?tab=readme-ov-file#community-libraries--sdks) for other languages, including [Dart](https://github.com/komape/deepl_dart), [Go](https://github.com/candy12t/go-deepl), and [Rust](https://github.com/Avimitin/deepl-rs). You may also wish to check out [these examples and guides](/docs/learning-how-tos/examples-and-guides).
+    [Our official client libraries](/docs/getting-started/client-libraries) let you use the API with six popular programming languages - [Python](https://www.github.com/deeplcom/deepl-python), [JavaScript](https://www.github.com/deeplcom/deepl-node), [PHP](https://www.github.com/deeplcom/deepl-php), [.NET](https://www.github.com/deeplcom/deepl-dotnet), [Java](https://www.github.com/deeplcom/deepl-java), or [Ruby](https://www.github.com/deeplcom/deepl-rb). The DeepL community has [contributed client libraries](https://github.com/DeepLcom/awesome-deepl?tab=readme-ov-file#community-libraries--sdks) for other languages, including [Dart](https://github.com/komape/deepl_dart), [Go](https://github.com/candy12t/go-deepl), and [Rust](https://github.com/Avimitin/deepl-rs). You may also wish to check out [these examples and guides](/docs/learning-how-tos/examples-and-guides).
   </Step>
 </Steps>
 

docs/getting-started/your-first-api-request.mdx

@@ -11,7 +11,7 @@ Once you've created a DeepL API account and located your authentication key, you
 
 To [translate text](/api-reference/translate), you can use the `/translate` endpoint, which also supports translation of [XML and HTML content](/api-reference/translate#in-text-markup).
 
-We included text translation examples for our [client libraries](/api-reference/client-libraries), too, just to give you an idea of what they look like.
+We included text translation examples for our [client libraries](/docs/getting-started/client-libraries), too, just to give you an idea of what they look like.
 
 <Tabs>
   <Tab title="HTTP Request">