Skip to content

docs: restructure IA around product lines (Phase 1) #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shirgoldbird wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: restructure IA around product lines (Phase 1) #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0ceaab
docs: restructure IA around product lines (Phase 1)
Apr 24, 2026
cdad273
docs: flatten detect/quality pages, nest customizations under transla…
Apr 24, 2026
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
214 changes: 116 additions & 98 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,98 +37,104 @@
{
"group": "Getting Started",
"pages": [
"docs/getting-started/about",
"docs/getting-started/quickstart",
"docs/getting-started/client-libraries"
]
},
{
"group": "Essentials",
"group": "Languages",
"pages": [
"docs/getting-started/supported-languages",
"docs/getting-started/auth",
"docs/getting-started/managing-api-keys",
"docs/getting-started/test-your-api-requests-with-postman",
"docs/getting-started/regional-endpoints"
"docs/learning-how-tos/examples-and-guides/enable-beta-languages",
"docs/resources/language-release-process"
]
},
{
"group": "Learning & How Tos",
"group": "Translate",
"pages": [
{
"group": "Guides",
"group": "Text Translation",
"pages": [
"docs/learning-how-tos/examples-and-guides/first-things-to-try-with-the-deepl-api",
"docs/learning-how-tos/examples-and-guides/translation-beginners-guide",
"docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter",
"docs/learning-how-tos/examples-and-guides/translating-between-variants",
"docs/learning-how-tos/examples-and-guides/glossaries-in-the-real-world",
"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",
"docs/learning-how-tos/examples-and-guides/how-to-use-translation-memories"
"docs/best-practices/language-detection"
]
},
"docs/best-practices/document-translations",
{
"group": "Cookbook",
"group": "XML & HTML",
"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"
"docs/xml-and-html-handling/xml",
"docs/xml-and-html-handling/structured-content",
"docs/xml-and-html-handling/html",
"docs/xml-and-html-handling/customized-xml-outline-detection",
"docs/xml-and-html-handling/tag-handling-v2"
]
}
]
},
{
"group": "Developer Tools",
"group": "Customizations",
"pages": [
"docs/getting-started/client-libraries-reference",
"docs/getting-started/deepl-cli",
"docs/getting-started/deepl-mcp-server"
"docs/learning-how-tos/examples-and-guides/glossaries-in-the-real-world",
"docs/best-practices/custom-instructions",
"docs/learning-how-tos/examples-and-guides/how-to-use-translation-memories"
]
},
{
"group": "Admin",
"pages": [
"docs/getting-started/managing-api-keys"
]
},
{
"group": "Best Practices",
"group": "Going to Production",
"pages": [
"docs/getting-started/regional-endpoints",
"docs/best-practices/pre-production-checklist",
"docs/best-practices/error-handling",
"docs/best-practices/cors-requests",
"docs/best-practices/document-translations",
"docs/best-practices/language-detection",
"docs/best-practices/cost-control",
"docs/best-practices/pre-production-checklist",
"docs/best-practices/custom-instructions"
"docs/best-practices/cors-requests",
"docs/resources/usage-limits"
]
},
{
"group": "XML and HTML handling",
"group": "Cookbooks",
"pages": [
"docs/xml-and-html-handling/xml",
"docs/xml-and-html-handling/structured-content",
"docs/xml-and-html-handling/customized-xml-outline-detection",
"docs/xml-and-html-handling/html",
"docs/xml-and-html-handling/tag-handling-v2"
"docs/learning-how-tos/cookbook/automating-indie-game-localization-with-the-deepl-api-and-godot",
"docs/learning-how-tos/cookbook/nodejs-proxy",
"docs/learning-how-tos/cookbook/java-document-translator",
"docs/learning-how-tos/cookbook/usage-analytics-dashboard",
"docs/learning-how-tos/examples-and-guides/deepl-mcp-server-how-to-build-and-use-translation-in-llm-applications",
"docs/learning-how-tos/cookbook/google-sheets"
]
},
{
"group": "Resources",
"group": "Developer Tools",
"pages": [
"docs/resources/roadmap-and-release-notes",
"docs/resources/usage-limits",
"docs/getting-started/deepl-cli",
"docs/getting-started/deepl-mcp-server",
"docs/getting-started/test-your-api-requests-with-postman",
"docs/resources/deepl-developer-community",
"docs/resources/open-api-spec"
]
},
{
"group": "API Updates",
"pages": [
"docs/resources/roadmap-and-release-notes",
"docs/resources/alpha-and-beta-features",
{
"group": "Breaking changes (change notices)",
"group": "Breaking changes",
"pages": [
"docs/resources/breaking-changes-change-notices",
"docs/resources/breaking-changes-change-notices/july-2024-deprecation-of-insecure-cipher-suites",
"docs/resources/breaking-changes-change-notices/march-2025-deprecating-get-requests-to-translate-and-authenticating-with-auth_key",
"docs/resources/breaking-changes-change-notices/november-2025-deprecation-of-legacy-auth-methods"
]
},
"docs/resources/language-release-process",
"docs/resources/alpha-and-beta-features",
"docs/resources/open-api-spec"
}
]
}
]
Expand All @@ -137,31 +143,26 @@
"tab": "API Reference",
"groups": [
{
"group": "API Reference",
"group": "Translate API",
"pages": [
{
"group": "Translate text",
"group": "Translate Text",
"pages": [
"api-reference/translate",
"api-reference/translate/request-translation"
]
},
{
"group": "Translate documents",
"group": "Translate Documents",
"pages": [
"api-reference/document",
"api-reference/document/upload-and-translate-a-document",
"api-reference/document/check-document-status",
"api-reference/document/download-translated-document"
]
},
{
"group": "Improve text",
"pages": [
"api-reference/improve-text",
"api-reference/improve-text/request-text-improvement"
]
},
"api-reference/detect-language/detect-language-beta",
"api-reference/quality-estimation/quality-estimation-alpha",
{
"group": "Glossaries",
"pages": [
Expand All @@ -176,7 +177,8 @@
"api-reference/multilingual-glossaries/deletes-the-dictionary-associated-with-the-given-language-pair-with-the-given-glossary-id",
"api-reference/multilingual-glossaries/replaces-or-creates-a-dictionary-in-the-glossary-with-the-specified-entries",
{
"group": "Manage Monolingual Glossaries",
"group": "Glossaries v2",
"tag": "DEPRECATED",
"pages": [
"api-reference/glossaries",
"api-reference/glossaries/v2-vs-v3-endpoints",
Expand All @@ -190,13 +192,7 @@
]
},
{
"group": "Translation memory",
"pages": [
"api-reference/translation-memory/list-translation-memories"
]
},
{
"group": "Style rules",
"group": "Style Rules",
"pages": [
"api-reference/style-rules",
"api-reference/style-rules/list-all-style-rules",
Expand All @@ -212,58 +208,76 @@
]
},
{
"group": "Retrieve usage and quota",
"group": "Translation Memory",
"pages": [
"api-reference/usage-and-quota",
"api-reference/usage-and-quota/check-usage-and-limits"
"api-reference/translation-memory/list-translation-memories"
]
},
}
]
},
{
"group": "Voice API",
"pages": [
"api-reference/voice",
"api-reference/voice/request-session",
"api-reference/voice/websocket-streaming",
"api-reference/voice/reconnect-session"
]
},
{
"group": "Write API",
"pages": [
"api-reference/improve-text",
"api-reference/improve-text/request-text-improvement"
]
},
{
"group": "Admin API",
"pages": [
"api-reference/admin-api",
"api-reference/admin-api/managing-admin-keys",
{
"group": "Detect language",
"group": "Managing Developer Keys",
"pages": [
"api-reference/detect-language/detect-language-beta"
"api-reference/admin-api/managing-developer-keys",
"api-reference/admin-api/managing-developer-keys/create-key",
"api-reference/admin-api/managing-developer-keys/get-keys",
"api-reference/admin-api/managing-developer-keys/deactivate-key",
"api-reference/admin-api/managing-developer-keys/rename-key",
"api-reference/admin-api/managing-developer-keys/set-usage-limits"
]
},
{
"group": "Retrieve languages",
"group": "Usage & Quota",
"pages": [
"api-reference/languages",
"api-reference/languages/retrieve-supported-languages",
{
"group": "Retrieve supported languages by product (v3) [BETA]",
"pages": [
"api-reference/languages/retrieve-supported-languages-by-product",
"api-reference/languages/language-feature-use-cases",
"api-reference/languages/retrieve-languages-by-product",
"api-reference/languages/retrieve-products",
"api-reference/languages/migrate-from-v2-languages",
"api-reference/languages/v3-languages-changelog"
]
}
"api-reference/usage-and-quota",
"api-reference/usage-and-quota/check-usage-and-limits"
]
},
{
"group": "Admin API",
"group": "Organization Usage Analytics",
"pages": [
"api-reference/admin-api",
"api-reference/admin-api/managing-admin-keys",
"api-reference/admin-api/managing-developer-keys",
"api-reference/admin-api/managing-developer-keys/create-key",
"api-reference/admin-api/managing-developer-keys/get-keys",
"api-reference/admin-api/managing-developer-keys/deactivate-key",
"api-reference/admin-api/managing-developer-keys/rename-key",
"api-reference/admin-api/managing-developer-keys/set-usage-limits",
"api-reference/admin-api/organization-usage-analytics",
"api-reference/admin-api/get-usage-analytics"
]
},
}
]
},
{
"group": "Languages",
"pages": [
"api-reference/languages",
"api-reference/languages/retrieve-supported-languages",
{
"group": "Translate Speech in Realtime",
"group": "v3 By-Product Endpoints",
"tag": "BETA",
"pages": [
"api-reference/voice",
"api-reference/voice/request-session",
"api-reference/voice/websocket-streaming",
"api-reference/voice/reconnect-session"
"api-reference/languages/retrieve-supported-languages-by-product",
"api-reference/languages/language-feature-use-cases",
"api-reference/languages/retrieve-languages-by-product",
"api-reference/languages/retrieve-products",
"api-reference/languages/migrate-from-v2-languages",
"api-reference/languages/v3-languages-changelog"
]
}
]
Expand All @@ -279,8 +293,12 @@
"navbar": {
"links": [
{
"label": "DeepL Web Translator",
"href": "https://www.deepl.com/translator"
"label": "API Pricing",
"href": "https://www.deepl.com/pro-api#api-pricing"
},
{
"label": "Manage Keys",
"href": "https://www.deepl.com/your-account/keys"
},
{
"label": "Contact Us",
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/client-libraries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Client libraries"
title: "SDKs"
description: "Using your favorite programming language with the DeepL API"
public: true
mode: "wide"
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/test-your-api-requests-with-postman.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Test your API requests with Postman"
title: "Postman"
description: "Use our official Postman collection to get familiar with and test the DeepL API."
mode: "wide"
public: true
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/roadmap-and-release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Roadmap and release notes"
title: "Changelog"
description: "The latest features and improvements in the DeepL API, plus what's coming next"
rss: true
---
Expand Down