Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR refactors the top-of-sidebar information architecture to keep “Getting Started” focused on onboarding, while moving broader material into new “Essentials” and “Developer Tools” sections and updating relevant internal links/redirects.
Changes:
- Renames “Introduction” to “Quickstart” and adds a redirect from
/docs/getting-started/introto/docs/getting-started/quickstart. - Reorganizes
docs.jsonnavigation groups (new “Essentials” and “Developer Tools”, and reorders “Guides”/“Cookbook” under “Learning & How Tos”). - Updates the translation beginner guide to use internal
/api-reference/...links, and adds it as a recommended next step in Quickstart.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/learning-how-tos/examples-and-guides/translation-beginners-guide.mdx | Switches several API reference links from external to internal /api-reference/... routes. |
| docs/getting-started/quickstart.mdx | Updates page title to “Quickstart” and adds a link to the translation beginner guide in the “quick steps” list. |
| docs.json | Restructures sidebar groups and adds the /docs/getting-started/intro → /docs/getting-started/quickstart redirect. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
| "docs/getting-started/about", | ||
| "docs/getting-started/quickstart", | ||
| "docs/getting-started/client-libraries", | ||
| "docs/getting-started/your-first-api-request" |
There was a problem hiding this comment.
| "docs/getting-started/your-first-api-request" |
The "your first API request" page doesn't provide any additional value on top of the quickstart, the only difference is that it also includes a sample Write API request. We should remove it, either entirely or at least from this section
| "docs/getting-started/intro", | ||
| "docs/getting-started/about", | ||
| "docs/getting-started/quickstart", | ||
| "docs/getting-started/client-libraries", |
There was a problem hiding this comment.
The client libraries page should be in the developer tools section
We've long known the "Getting started" area is too big , and contains many items that are not about just getting started with the API. People tend to add new docs entries to this area because we all want our new content to be at the top - but it can't all be at the top. I moved a few items down some time ago, and now the area has once again grown bloated.
A few of us have long wanted to at least divide this area into two sections. So, here's what I did:
And a bonus:
I'm not sure about the word "Essentials", but it's the best I could think of. Claude's suggestions were worse.
I wasn't sure we wanted a "Developer tools" section with two items, but when I added this, I thought it looked quite nice, so I kept it.
Comments and improvements desired! I'll let this change marinate until at least after Easter holidays, so folks have a chance to notice it.