Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
jacksonyzj
force-pushed
the
adk-v2-get-started
branch
from
303b662 to
351d825
Compare
jacksonyzj
force-pushed
the
adk-v2-get-started
branch
2 times, most recently
from
0b7c984 to
1bc993f
Compare
Add the Install page covering CLI prerequisites, install scripts for macOS/Linux/Windows, version pinning, custom install directory, self-upgrade, and the npm alternative. Empty placeholders for quickstart, welcome, and quickstart-with-coding-assistant land alongside to establish the v2 get-started structure.
jacksonyzj
force-pushed
the
adk-v2-get-started
branch
from
1bc993f to
7801ce1
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
…arted section Consolidates the ADK v2 install and quickstart drafts into a new Get started folder inside the existing ADK docs, and removes the standalone introduction, quickstart, and project-structure pages whose content is folded into the new pages (or covered by upcoming v2 concept pages). Drops the separate ADK v2 sidebar group. Updates docs.json, the ADK card on the home page, and the Zai overview link to point at the new paths so the broken-links check stays green.
jacksonyzj
changed the title
…nking in quickstart
| @@ -0,0 +1,21 @@ | |||
| --- | |||
There was a problem hiding this comment.
Overall thoughts about this category: with the introduction of a dedicated "Get started" category, we're doubling the amount of clicks for someone to land on Quickstart. In practice, this will end up being fine since "Get started" will eventually be a top-level category with its pages listed flat (i.e. not in a dropdown), but until then it's a regression in developer experience.
Probably not the end of the world but something to think about - do you think it makes sense for these pages to remain flat in the ADK category until then?
| --- | ||
| title: Botpress ADK | ||
| sidebarTitle: Welcome | ||
| description: The Botpress Agent Development Kit (ADK) is a developer-first TypeScript framework for building AI agents on the Botpress Platform. |
There was a problem hiding this comment.
- Writing Botpress Agent Development Kit makes it seem like the abbreviation should be BADK
- Might be missing something but isn't "developer-first TS framework" a bit of an oxymoron? any TS framework is going to be for developers first
- Not a huge deal but I would tighten it a bit since it's gonna be used as the page's meta description:
| description: The Botpress Agent Development Kit (ADK) is a developer-first TypeScript framework for building AI agents on the Botpress Platform. | |
| description: TypeScript framework for building AI agents on Botpress. |
| <Card title="What's new" icon="newspaper" href="/changelog"> | ||
| Latest features, improvements, and breaking changes. | ||
| </Card> | ||
| </CardGroup> |
There was a problem hiding this comment.
Thoughts on this page in particular: developers tend to be quick-thinking and goal-oriented. As it stands, I don't think this page offers much in the way of DX - it offers nothing actionable or clickable without scrolling (at least not on a typical MacBook viewport).
Look at the landing pages for some industry leaders' dev docs:
They all emphasize useful code snippets and buttons that point you in the right direction. I don't think including an image is out of place given that we want to emphasize the Control Panel / Agent 0, but put yourself in the shoes of a dev who's curious about the ADK - what would you value seeing first?
| @@ -0,0 +1,62 @@ | |||
| --- | |||
| title: Quickstart with coding assistant | |||
| description: Let's get the same hello-world agent set up, with your AI coding assistant doing the work. | |||
There was a problem hiding this comment.
Like in the "Welcome" page, these descriptions are used as meta descriptions for SEO and shouldn't be conversational
| @@ -0,0 +1,90 @@ | |||
| --- | |||
| title: Quickstart | |||
| description: Let's get set up with a quick hello-world agent built with the ADK. | |||
| You'll need [Node.js](https://nodejs.org/) 22.0.0 or higher and a [Botpress account](https://sso.botpress.cloud) to log in with. | ||
| </Info> | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
General thoughts: this reworking of the quickstart guide removes a lot of content, like many commands' output and explanations. I'm curious about the reasoning behind this?
| You'll need [Node.js](https://nodejs.org/) 22.0.0 or higher, a [Botpress account](https://sso.botpress.cloud), and an AI coding assistant like Claude Code, Cursor, or Codex. | ||
| </Info> | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
I would recommend using standard markdown headings instead of the Steps component here, if only because individual steps aren't included in the page TOC, which makes the page less sca
| You'll need [Node.js](https://nodejs.org/) 22.0.0 or higher and a [Botpress account](https://sso.botpress.cloud) to log in with. | ||
| </Info> | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
Same as above, use standard markdown headings
| You'll need [Node.js](https://nodejs.org/) 22.0.0 or higher, a [Botpress account](https://sso.botpress.cloud), and an AI coding assistant like Claude Code, Cursor, or Codex. | ||
| </Info> | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
My gut tells me that these 2 shouldn't be separate pages, but both live in "Quickstart", maybe under separate tabs or something. If I'm a dev and I see 2 pages that both contain the word "Quickstart", it's a little confusing
There was a problem hiding this comment.
Why did we remove this page?
2 participants
Summary
Adds a new Get started section to the ADK docs with four pages: Welcome, Install, Quickstart, and Quickstart with coding assistant. Removes the old standalone Introduction, Quickstart, and Project Structure pages, restructures the ADK sidebar accordingly, and updates the home page + Zai page to link to the new paths.
Test plan
Open https://botpress-adk-v2-get-started.mintlify.app/adk/get-started/welcome and walk through all four Get started pages.