Refactor top of sidebar #289
+37
−28
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| --- | ||
| 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 | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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](/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](/api-reference/document) | ||
| * To translate audio, see [the `/voice` reference](/api-reference/voice) | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.