Skip to content

docs: fix typos, stale content, and port inconsistencies #2144

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

Open
mesutoezdil wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix typos, stale content, and port inconsistencies #2144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c5f620
docs: fix typos, stale content, and port inconsistencies
mesutoezdil Jul 3, 2026
af180b7
docs: update substrate version to 0.0.8
mesutoezdil Jul 7, 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
12 changes: 6 additions & 6 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,21 +45,21 @@ make --version
make create-kind-cluster
```

1. Configure the cluster and set the default namespace `kagent`:
2. Configure the cluster and set the default namespace `kagent`:

```shell
make use-kind-cluster
```

1. Set your model provider:
3. Set your model provider:

```shell
export KAGENT_DEFAULT_MODEL_PROVIDER=openAI
#or
export KAGENT_DEFAULT_MODEL_PROVIDER=anthropic
```

1. Set your providers API_KEY:
4. Set your providers API_KEY:

```shell
export OPENAI_API_KEY=your-openai-api-key
Expand All @@ -81,7 +81,7 @@ OPENAI_API_KEY=your-openai-api-key
# GOOGLE_API_KEY=your-google-api-key
```

1. Build images, load them into kind cluster and deploy everything using Helm:
5. Build images, load them into kind cluster and deploy everything using Helm:

```shell
make helm-install
Expand All @@ -99,10 +99,10 @@ KAGENT_HELM_EXTRA_ARGS=-f helm/kagent/values.local.yaml
To access the UI, port-forward to the UI port on the `kagent-ui` service:

```shell
kubectl port-forward svc/kagent-ui 8001:8080
kubectl port-forward svc/kagent-ui 3000:8080
```

Then open your browser and go to `http://localhost:8001`.
Then open your browser and go to `http://localhost:3000`.

### Addons

Expand Down
8 changes: 4 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,9 @@ check-api-key: ## Validate required API key for the configured model provider
exit 1; \
fi; \
elif [ "$(KAGENT_DEFAULT_MODEL_PROVIDER)" = "azureOpenAI" ]; then \
if [ -z "$(AZUREOPENAI_API_KEY)" ]; then \
echo "Error: AZUREOPENAI_API_KEY environment variable is not set for Azure OpenAI provider"; \
echo "Please set it with: export AZUREOPENAI_API_KEY=your-api-key"; \
if [ -z "$(AZURE_OPENAI_API_KEY)" ]; then \
echo "Error: AZURE_OPENAI_API_KEY environment variable is not set for Azure OpenAI provider"; \
echo "Please set it with: export AZURE_OPENAI_API_KEY=your-api-key"; \
exit 1; \
fi; \
elif [ "$(KAGENT_DEFAULT_MODEL_PROVIDER)" = "gemini" ]; then \
Expand Down Expand Up @@ -488,7 +488,7 @@ helm-install-provider: helm-version check-api-key
--set ui.image.pullPolicy=Always \
--set controller.service.type=LoadBalancer \
--set providers.openAI.apiKey=$(OPENAI_API_KEY) \
--set providers.azureOpenAI.apiKey=$(AZUREOPENAI_API_KEY) \
--set providers.azureOpenAI.apiKey=$(AZURE_OPENAI_API_KEY) \
--set providers.anthropic.apiKey=$(ANTHROPIC_API_KEY) \
--set providers.gemini.apiKey=$(GOOGLE_API_KEY) \
--set providers.default=$(KAGENT_DEFAULT_MODEL_PROVIDER) \
Expand Down
3 changes: 1 addition & 2 deletions docs/substrate-agentharness-lifecycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ The substrate reconcile path should:
2. Verify the `WorkerPool` exists.
3. Create or update the generated `ActorTemplate` with an owner reference to the `AgentHarness`.
4. Wait for `ActorTemplate.status.phase == Ready`.
5. Create or resume the actor through `ate-api`.
6. Mark `ActorReady` and aggregate `Ready`.
5. Mark `ActorTemplateReady` and aggregate `Ready`. Actors are created on demand by the HTTP gateway on the first chat connection.

## Delete

Expand Down
7 changes: 3 additions & 4 deletions examples/substrate-openclaw/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ on the kagent chart), prefix these keys with `substrate.` — e.g.
Then install the Substrate platform and kagent:

```bash
export SUBSTRATE_VERSION=0.0.7
export SUBSTRATE_VERSION=0.0.8

helm upgrade --install substrate-crds \
oci://ghcr.io/kagent-dev/substrate/helm/substrate-crds \
Expand Down Expand Up @@ -83,7 +83,6 @@ metadata:
name: peterj-claw
namespace: kagent
spec:
runtime: substrate
backend: openclaw
description: OpenClaw on Agent Substrate
modelConfigRef: default-model-config
Expand Down Expand Up @@ -145,12 +144,12 @@ With `controller.substrate.enabled=true`, the kagent Helm chart installs a names
Port-forward the UI:

```bash
kubectl port-forward -n kagent svc/kagent-ui 8001:8080
kubectl port-forward -n kagent svc/kagent-ui 3000:8080

@EItanya EItanya Jul 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change, seems arbitrary?

```

Navigate to the deployed agent harness. If the OpenClaw Control UI asks for a gateway connection, use:

- Gateway URL: `http://localhost:8001/api/agentharnesses/kagent/peterj-claw/gateway/`
- Gateway URL: `http://localhost:3000/api/agentharnesses/kagent/peterj-claw/gateway/`

The gateway URL must include the trailing slash. The gateway runs without authentication; the actor's only externally reachable surface is reached through the controller's same-origin proxy over the actor's private atenet ingress.

Expand Down
6 changes: 3 additions & 3 deletions helm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ helm install kagent ./helm/kagent/ --namespace kagent --set providers.openAI.api
helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=ollama
helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=openAI --set providers.openAI.apiKey=your-openai-api-key
helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=anthropic --set providers.anthropic.apiKey=your-anthropic-api-key
helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=azureOpenAI --set providers.azureOpenAI.apiKey=your-openai-api-key
helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=azureOpenAI --set providers.azureOpenAI.apiKey=your-azure-openai-api-key
```

### Using Make
Expand All @@ -27,7 +27,7 @@ helm install kagent ./helm/kagent/ --namespace kagent --set providers.default=az
# export your openAI key
export OPENAI_API_KEY=your-openai-api-key
export ANTHROPIC_API_KEY=your-anthropic-api-key
export AZUREOPENAI_API_KEY=your-azure-api-key
export AZURE_OPENAI_API_KEY=your-azure-api-key

# install the kagent charts with openAI provider
make KAGENT_DEFAULT_MODEL_PROVIDER=openAI helm-install
Expand All @@ -48,7 +48,7 @@ make KAGENT_DEFAULT_MODEL_PROVIDER=ollama helm-install
## make sure have env variable with your API_KEY
export OPENAI_API_KEY=your-openai-api-key
export ANTHROPIC_API_KEY=your-anthropic-api-key
export AZURE_API_KEY=your-azure-api-key
export AZURE_OPENAI_API_KEY=your-azure-api-key

#default provider is openAI but you can select from the list
export KAGENT_DEFAULT_MODEL_PROVIDER=ollama
Expand Down
2 changes: 1 addition & 1 deletion python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prerequisites
- [uv package manager](https://docs.astral.sh/uv/getting-started/installation/)
- OpenAI API key
- An LLM provider API key (OpenAI, Anthropic, Gemini, etc.)

## Python

Expand Down
2 changes: 1 addition & 1 deletion ui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# kagents ui
# kagent ui


```bash
Expand Down
Loading