docs(adk-v2): get started section #457
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| --- | ||
|
|
||
| <Info> | ||
| 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. | ||
|
Collaborator
There was a problem hiding this comment. Try to follow the same pattern for listing prerequisites as the rest of the docs |
||
| </Info> | ||
|
|
||
| <Steps> | ||
|
Collaborator
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
Collaborator
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 |
||
| <Step title="Install the ADK CLI"> | ||
| Run the install command for your operating system: | ||
|
|
||
| <AccordionGroup> | ||
| <Accordion title="macOS & Linux"> | ||
| ```bash | ||
| curl -fsSL https://github.com/botpress/adk/releases/latest/download/install.sh | bash | ||
| ``` | ||
| </Accordion> | ||
| <Accordion title="Windows (PowerShell)"> | ||
| ```powershell | ||
| powershell -c "irm https://github.com/botpress/adk/releases/latest/download/install.ps1 | iex" | ||
| ``` | ||
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| Then verify: | ||
|
|
||
| ```bash | ||
| adk --version | ||
| ``` | ||
| </Step> | ||
|
|
||
| <Step title="Log in to Botpress"> | ||
| ```bash | ||
| adk login | ||
| ``` | ||
|
|
||
| Follow the prompts to sign in through your browser. | ||
| </Step> | ||
|
|
||
| <Step title="Hand it off to your coding assistant"> | ||
| Open your coding assistant in an empty folder and paste this prompt: | ||
|
|
||
| ```txt | ||
| Let's get set up with a quick hello-world agent built with the ADK. Scaffold the project, start the dev server, and deploy it to Botpress Cloud when it's working. | ||
| ``` | ||
|
|
||
| The assistant runs `adk init`, `adk dev`, and `adk deploy` for you. Review each change it proposes, and you'll have a live agent when it's done. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## Next steps | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Project structure" icon="folder" href="/adk/concepts/configuration"> | ||
| See what an ADK project looks like. | ||
| </Card> | ||
| <Card title="Conversations" icon="message-square" href="/adk/concepts/conversations"> | ||
| Define how your agent talks to users across channels. | ||
| </Card> | ||
| </CardGroup> | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,90 @@ | ||||||
| --- | ||||||
| title: Quickstart | ||||||
| description: Let's get set up with a quick hello-world agent built with the ADK. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| <Info> | ||||||
|
|
||||||
| 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> | ||||||
|
Collaborator
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?
Collaborator
There was a problem hiding this comment. Same as above, use standard markdown headings |
||||||
| <Step title="Install the ADK CLI"> | ||||||
| Run the install command for your operating system: | ||||||
|
|
||||||
| <AccordionGroup> | ||||||
|
|
||||||
| <Accordion title="macOS & Linux"> | ||||||
| ```bash | ||||||
| curl -fsSL https://github.com/botpress/adk/releases/latest/download/install.sh | bash | ||||||
| ``` | ||||||
| </Accordion> | ||||||
| <Accordion title="Windows (PowerShell)"> | ||||||
| ```powershell | ||||||
| powershell -c "irm https://github.com/botpress/adk/releases/latest/download/install.ps1 | iex" | ||||||
| ``` | ||||||
| </Accordion> | ||||||
| </AccordionGroup> | ||||||
|
|
||||||
| Open a new terminal and verify the installation: | ||||||
|
|
||||||
| ```bash | ||||||
| adk --version | ||||||
| ``` | ||||||
| </Step> | ||||||
|
|
||||||
| <Step title="Log in to Botpress"> | ||||||
| Authenticate with your Botpress account: | ||||||
|
|
||||||
| ```bash | ||||||
| adk login | ||||||
| ``` | ||||||
|
|
||||||
| Follow the prompts to sign in through your browser. The CLI saves your credentials for every command that follows. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step title="Create a project"> | ||||||
| Scaffold a new project: | ||||||
|
|
||||||
| ```bash | ||||||
| adk init my-agent | ||||||
| cd my-agent | ||||||
| ``` | ||||||
|
|
||||||
| Pick the `hello-world` template when prompted. The wizard also asks for a package manager and a Botpress workspace to link the project to. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step title="Run your agent locally"> | ||||||
| Start the dev server: | ||||||
|
|
||||||
| ```bash | ||||||
| adk dev | ||||||
| ``` | ||||||
|
|
||||||
| Open the dev console at [http://localhost:3001](http://localhost:3001) and head to the **Chat** page to talk to your agent. | ||||||
|
|
||||||
| <Frame> | ||||||
| <img alt="ADK dev console" className="block dark:hidden" src="../assets/quickstart.png" /> | ||||||
| <img alt="ADK dev console" className="hidden dark:block" src="../assets/quickstart-dark.png" /> | ||||||
| </Frame> | ||||||
| </Step> | ||||||
|
|
||||||
| <Step title="Deploy to Botpress Cloud"> | ||||||
|
Collaborator
There was a problem hiding this comment. "Botpress Cloud" is outdated terminology
Suggested change
|
||||||
| Ship your agent: | ||||||
|
|
||||||
| ```bash | ||||||
| adk deploy | ||||||
| ``` | ||||||
|
|
||||||
| This builds a production bundle and uploads it to the workspace you linked during `adk init`. Chat with your live agent from your Botpress Cloud workspace. | ||||||
| </Step> | ||||||
| </Steps> | ||||||
|
|
||||||
| ## Next steps | ||||||
|
|
||||||
| <CardGroup cols={2}> | ||||||
| <Card title="Project structure" icon="folder" href="/adk/concepts/configuration"> | ||||||
| See what an ADK project looks like. | ||||||
| </Card> | ||||||
| <Card title="Build with a coding assistant" icon="sparkles" href="/adk/get-started/quickstart-coding-assistant"> | ||||||
| Pair the ADK with Claude Code, Cursor, or Codex using ADK skills. | ||||||
| </Card> | ||||||
| </CardGroup> | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,21 @@ | ||||||
| --- | ||||||
|
Collaborator
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. | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
| --- | ||||||
|
|
||||||
| <Frame> | ||||||
| <img alt="Botpress ADK" className="block dark:hidden" src="../assets/welcome.png" /> | ||||||
| <img alt="Botpress ADK" className="hidden dark:block" src="../assets/welcome-dark.png" /> | ||||||
| </Frame> | ||||||
|
|
||||||
| ## Start here | ||||||
|
|
||||||
| <CardGroup cols={2}> | ||||||
| <Card title="Quickstart" icon="rocket" href="/adk/get-started/quickstart"> | ||||||
| Build and deploy your first agent in minutes. | ||||||
| </Card> | ||||||
| <Card title="What's new" icon="newspaper" href="/changelog"> | ||||||
| Latest features, improvements, and breaking changes. | ||||||
| </Card> | ||||||
| </CardGroup> | ||||||
|
Collaborator
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? |
||||||
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.
Like in the "Welcome" page, these descriptions are used as meta descriptions for SEO and shouldn't be conversational