Skip to content

Refactor top of sidebar #289

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

Merged
morsssss merged 4 commits into from
Apr 15, 2026
Merged

Refactor top of sidebar #289

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b218896
Refactor top of sidebar
morsssss Apr 3, 2026
7ee079c
Remove "Your first API request" page and redirect to quickstart
shirgoldbird Apr 9, 2026
1237d0c
Left sidebar followup
morsssss Apr 9, 2026
b1f9334
Unmangled language a bit
morsssss Apr 15, 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
55 changes: 32 additions & 23 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Copy Markdown
Member

@shirgoldbird shirgoldbird Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The client libraries page should be in the developer tools section

Copy link
Copy Markdown
Contributor Author

@morsssss morsssss Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. Right now it's not easy to learn anything about our client libraries on this site, unless you happen to be one of the intro pages. It's not great that people have to navigate to github to learn how to use them, but at least a persistent sidebar link makes them discoverable. For the great majority of developers, finding info on their client library is also an essential part of getting started.

Copy link
Copy Markdown
Member

@shirgoldbird shirgoldbird Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The page lives under Getting Started, which implies tutorial/onboarding content. But this is pure reference (a catalog of libraries). Users in "getting started" mode expect guidance on which library to pick and how to install it — they get a link list instead.

Recommendation: Move this page to Developer Tools, and add a how-to guide ("How to install a DeepL client library") to this section that includes installation commands for each language.

Copy link
Copy Markdown
Contributor Author

@morsssss morsssss Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like your idea in the abstract... but I don't think people need a guide for how to install each client library. There's not much to say! These instructions are already in the github repos, and I think that's a logical place for them.

On the other hand, I agree that this page is not very getting-started-y as it stands. Beginners won't need to know about out-of-the-box retries etc.

How about this: I could start this off with a couple of paragraphs explaining about what the client libraries are, what they do, where to find documentation and examples. There wouldn't be much. I think the link boxes are still useful. We could then remove/rewrite the "features include" area or put it elsewhere. The rest could be in a "see also" area.

"docs/getting-started/your-first-api-request"
Comment thread
shirgoldbird marked this conversation as resolved.
Outdated
]
},
{
"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": [
Expand All @@ -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": [
Expand Down Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/intro.mdx → docs/getting-started/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Introduction"
description: "Welcome to the developer home of DeepL API."
title: "Quickstart"
public: true
mode: "wide"
---
Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/learning-how-tos/examples-and-guides/translation-beginners-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)