From b21889678c78606af18ac5d46c867e9abc39e1af Mon Sep 17 00:00:00 2001 From: Ben Morss Date: Thu, 2 Apr 2026 20:07:53 -0400 Subject: [PATCH] Refactor top of sidebar Changed "intro" to "quickstart", added redirect Made "Getting started" area only about getting started, for new users Made new "Essentials" and "Developer tools" areas for other things Made some links that opened a new tab, not open a new tab --- docs.json | 55 +++++++++++-------- .../{intro.mdx => quickstart.mdx} | 4 +- .../translation-beginners-guide.mdx | 6 +- 3 files changed, 37 insertions(+), 28 deletions(-) rename docs/getting-started/{intro.mdx => quickstart.mdx} (98%) diff --git a/docs.json b/docs.json index bcd33f1..8ba93c6 100644 --- a/docs.json +++ b/docs.json @@ -37,38 +37,25 @@ { "group": "Getting Started", "pages": [ - "docs/getting-started/intro", "docs/getting-started/about", + "docs/getting-started/quickstart", + "docs/getting-started/client-libraries", + "docs/getting-started/your-first-api-request" + ] + }, + { + "group": "Essentials", + "pages": [ + "docs/getting-started/supported-languages", "docs/getting-started/auth", - "docs/getting-started/regional-endpoints", - { - "group": "Developer Tools", - "pages": [ - "docs/getting-started/client-libraries", - "docs/getting-started/deepl-cli", - "docs/getting-started/deepl-mcp-server" - ] - }, "docs/getting-started/managing-api-keys", - "docs/getting-started/your-first-api-request", "docs/getting-started/test-your-api-requests-with-postman", - "docs/getting-started/supported-languages" + "docs/getting-started/regional-endpoints" ] }, { "group": "Learning & How Tos", "pages": [ - { - "group": "Cookbook", - "pages": [ - "docs/learning-how-tos/cookbook", - "docs/learning-how-tos/cookbook/google-sheets", - "docs/learning-how-tos/cookbook/automating-indie-game-localization-with-the-deepl-api-and-godot", - "docs/learning-how-tos/cookbook/java-document-translator", - "docs/learning-how-tos/cookbook/usage-analytics-dashboard", - "docs/learning-how-tos/cookbook/nodejs-proxy" - ] - }, { "group": "Guides", "pages": [ @@ -80,9 +67,27 @@ "docs/learning-how-tos/examples-and-guides/placeholder-tags", "docs/learning-how-tos/examples-and-guides/deepl-mcp-server-how-to-build-and-use-translation-in-llm-applications" ] + }, + { + "group": "Cookbook", + "pages": [ + "docs/learning-how-tos/cookbook", + "docs/learning-how-tos/cookbook/google-sheets", + "docs/learning-how-tos/cookbook/automating-indie-game-localization-with-the-deepl-api-and-godot", + "docs/learning-how-tos/cookbook/java-document-translator", + "docs/learning-how-tos/cookbook/usage-analytics-dashboard", + "docs/learning-how-tos/cookbook/nodejs-proxy" + ] } ] }, + { + "group": "Developer Tools", + "pages": [ + "docs/getting-started/deepl-cli", + "docs/getting-started/deepl-mcp-server" + ] + }, { "group": "Best Practices", "pages": [ @@ -406,6 +411,10 @@ "source": "/docs/getting-started/alpha-and-beta-features", "destination": "/docs/resources/alpha-and-beta-features" }, + { + "source": "/docs/getting-started/intro", + "destination": "/docs/getting-started/quickstart" + }, { "source": "/docs/resources/release-notes", "destination": "/docs/resources/roadmap-and-release-notes" diff --git a/docs/getting-started/intro.mdx b/docs/getting-started/quickstart.mdx similarity index 98% rename from docs/getting-started/intro.mdx rename to docs/getting-started/quickstart.mdx index 4e048fc..3d8547c 100644 --- a/docs/getting-started/intro.mdx +++ b/docs/getting-started/quickstart.mdx @@ -1,6 +1,5 @@ --- -title: "Introduction" -description: "Welcome to the developer home of DeepL API." +title: "Quickstart" public: true mode: "wide" --- @@ -247,6 +246,7 @@ New user? Follow these quick steps to get started with the DeepL API. - [Your first API request](/docs/getting-started/your-first-api-request) - With just a few lines of code, make your first request to the DeepL Translate or Write API - [**DeepL 101**](/docs/learning-how-tos/examples-and-guides/first-things-to-try-with-the-deepl-api) - A quick guide to text and document translation, using Postman to play with the API, client libraries for your favorite programming language, and joining our developer community +- [Translation: a beginner's guide](/docs/learning-how-tos/examples-and-guides/translation-beginners-guide) - A detailed guide to fundamental translation features - [Cookbook](/docs/learning-how-tos/cookbook) - Explore short tutorials, examples, projects, and use cases - [Guides](/docs/learning-how-tos/examples-and-guides) - Discover in-depth explanations for API features and real-world applications diff --git a/docs/learning-how-tos/examples-and-guides/translation-beginners-guide.mdx b/docs/learning-how-tos/examples-and-guides/translation-beginners-guide.mdx index 5c82541..0a05443 100644 --- a/docs/learning-how-tos/examples-and-guides/translation-beginners-guide.mdx +++ b/docs/learning-how-tos/examples-and-guides/translation-beginners-guide.mdx @@ -845,8 +845,8 @@ Congratulations! Now you know how to send the DeepL API a translation request in Here are some possible next steps: * Play with translation requests using these parameters and other options in [our playground](https://developers.deepl.com/api-reference/translate/request-translation?playground=open) or [Postman](/docs/getting-started/test-your-api-requests-with-postman). -* For complete information on the `/translate` endpoint, see [the /translate reference](https://developers.deepl.com/api-reference/translate/request-translation) +* For complete information on the `/translate` endpoint, see [the `/translate` reference](/api-reference/translate/request-translation) * See this [introduction to DeepL glossaries](/docs/learning-how-tos/examples-and-guides/glossaries-in-the-real-world) -* To learn how to translate text in files - PDFs, presentations, powerpoints, HTML, images, and more - see [the /document reference](https://developers.deepl.com/api-reference/document) -* To translate audio, see [the /voice endpoint](https://developers.deepl.com/api-reference/voice) +* To learn how to translate text in files - PDFs, presentations, powerpoints, HTML, images, and more - see [the `/document` reference](/api-reference/document) +* To translate audio, see [the `/voice` reference](/api-reference/voice)