Skip to content

docs: PR 1 Audit and Fix Broken/Outdated Code Examples in Documentation #1910

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
pilartomas merged 8 commits into from
Feb 5, 2026
Merged

docs: PR 1 Audit and Fix Broken/Outdated Code Examples in Documentation #1910

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c0fca70
Fixed dquote> for not properly escaping special charater bug in quic…
sandijean90 Jan 27, 2026
b916753
Adding details for one line install to dev and stable
sandijean90 Jan 27, 2026
3832b6d
uv consistency and testing wrap-exisiting-agent page
sandijean90 Jan 27, 2026
2916b72
Fixed the quickstart install directions - take 1
sandijean90 Jan 28, 2026
4642305
revising build agents page
sandijean90 Jan 29, 2026
4aee36b
Revising quickstart based on comments v2
sandijean90 Jan 29, 2026
b373ee2
updating based on comments
sandijean90 Feb 2, 2026
7684cdf
Revision of Messages Page
sandijean90 Feb 3, 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
38 changes: 31 additions & 7 deletions docs/development/introduction/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,31 @@ Open the terminal and run this command to install Agent Stack:
sh -c "$(curl -LsSf https://raw.githubusercontent.com/i-am-bee/agentstack/install/install.sh)"
```

This interactive script installs Agent Stack CLI, downloads and starts the platform, prompts you to configure your LLM API key, then launches the web interface.
### Installation Lifecycle
The Agent Stack interactive script handles the environment configuration and platform deployment through three phases.
<CardGroup cols={1}>
<Card title="1. Environment Initialization" icon="gears">
Prepares the local system by managing core dependencies:

- **Package Management:** Installs `uv` and the Agent Stack CLI.
- **Language Runtime:** Ensures the correct Python version and removes legacy versions.
</Card>

<Card title="2. Platform Deployment" icon="server">
Automates the provisioning of a local Kubernetes-based environment:

- **Infrastructure:** Initializes `Lima`, `k3s`, and `Helm`.
- **Orchestration:** Pulls service images for the server, UI, and PostgreSQL.
- **Networking:** Deploys Helm charts and maps the platform to `localhost:8333`.
</Card>

<Card title="3. Provider Configuration" icon="key">
The final stage bridges the platform to your intelligence layer:

- **Server Log In:** Starts an active server session.
- **Connectivity:** Prompts for **LLM provider setup** to enable model access.
</Card>
</CardGroup>

<Accordion title="Manual Install">

Expand Down Expand Up @@ -165,12 +189,12 @@ Follow the interactive prompts to finish the installation and setup.
## Usage

```sh
agentstack ui # Launch web interface
agentstack list # See what agents are available
agentstack run chat "Hi!" # Send a message to chat agent
agentstack run chat # Try interactive mode
agentstack info chat # View agent details
agentstack --help # See all options
agentstack ui # Launch web interface
agentstack list # See what agents are available
agentstack run chat "Hi, who are you" # Send a message to chat agent
agentstack run chat # Try interactive mode
agentstack info chat # View agent details
agentstack --help # See all options
```

## Platform Management
Expand Down
40 changes: 32 additions & 8 deletions docs/stable/introduction/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,32 @@ Open the terminal and run this command to install Agent Stack:
```bash
sh -c "$(curl -LsSf https://raw.githubusercontent.com/i-am-bee/agentstack/install/install.sh)"
```

This interactive script installs Agent Stack CLI, downloads and starts the platform, prompts you to configure your LLM API key, then launches the web interface.
### Installation Lifecycle
The Agent Stack interactive script handles the environment configuration and platform deployment through three phases.

<CardGroup cols={1}>
<Card title="1. Environment Initialization" icon="gears">
Prepares the local system by managing core dependencies:

- **Package Management:** Installs `uv` and the Agent Stack CLI.
- **Language Runtime:** Ensures the correct Python version and removes legacy versions.
</Card>

<Card title="2. Platform Deployment" icon="server">
Automates the provisioning of a local Kubernetes-based environment:

- **Infrastructure:** Initializes `Lima`, `k3s`, and `Helm`.
- **Orchestration:** Pulls service images for the server, UI, and PostgreSQL.
- **Networking:** Deploys Helm charts and maps the platform to `localhost:8333`.
</Card>

<Card title="3. Provider Configuration" icon="key">
The final stage bridges the platform to your intelligence layer:

- **Server Log In:** Starts an active server session.
- **Connectivity:** Prompts for **LLM provider setup** to enable model access.
</Card>
</CardGroup>

<Accordion title="Manual Install">

Expand Down Expand Up @@ -165,12 +189,12 @@ Follow the interactive prompts to finish the installation and setup.
## Usage

```sh
agentstack ui # Launch web interface
agentstack list # See what agents are available
agentstack run chat "Hi!" # Send a message to chat agent
agentstack run chat # Try interactive mode
agentstack info chat # View agent details
agentstack --help # See all options
agentstack ui # Launch web interface
agentstack list # See what agents are available
agentstack run chat "Hi, who are you" # Send a message to chat agent
agentstack run chat # Try interactive mode
agentstack info chat # View agent details
agentstack --help # See all options
```

## Platform Management
Expand Down
Loading