update docs with substrate and ACP info#400
Merged
Merged
Conversation
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the kagent documentation set to reflect the shift toward Agent Substrate–backed execution and ACP-based harness chat, removing the older Agent Sandbox walkthrough and adding Mermaid diagram rendering support for docs.
Changes:
- Render fenced ```mermaid code blocks as diagrams in MDX content.
- Update kagent docs and navigation to describe AgentHarness and sandboxing in terms of Agent Substrate + ACP.
- Remove the Agent Sandbox example page and related navigation/sitemap entries.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/mdx-components.tsx | Adds Mermaid rendering for fenced mermaid code blocks in MDX. |
| src/config/navigation.json | Updates AgentHarness descriptions and removes Agent Sandbox from navigation. |
| src/app/docs/kagent/introduction/installation/page.mdx | Rewrites AgentHarness enablement to install/enable Agent Substrate integration. |
| src/app/docs/kagent/examples/page.mdx | Removes Agent Sandbox quick link; updates Agent Harness description. |
| src/app/docs/kagent/examples/agent-substrate/page.mdx | Updates substrate walkthrough and SandboxAgent instructions for the new substrate framing. |
| src/app/docs/kagent/examples/agent-sandbox/page.mdx | Deletes the Agent Sandbox example page. |
| src/app/docs/kagent/examples/agent-harness/page.mdx | Updates AgentHarness example to substrate requirements and ACP chat guidance. |
| src/app/docs/kagent/concepts/page.mdx | Updates Agent Harness concept card description to substrate/ACP language. |
| src/app/docs/kagent/concepts/agents/page.mdx | Reframes “Sandboxed Agents” section around Agent Substrate. |
| src/app/docs/kagent/concepts/agent-substrate/page.mdx | Updates AgentHarness section to state substrate-only + ACP framing. |
| src/app/docs/kagent/concepts/agent-harness/page.mdx | Rewrites AgentHarness concept page; adds Mermaid architecture diagram and ACP explanation. |
| src/app/docs/_constants.ts | Removes Agent Sandbox-related version/API constants. |
| public/sitemap.xml | Removes Agent Sandbox URL and updates lastmod dates. |
| package-lock.json | Adds unist-util-visit to dependencies (used by remark version substitution). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
185
to
197
| spec: | ||
| type: Declarative | ||
| description: Tiny declarative agent running inside a substrate actor | ||
| declarative: | ||
| runtime: go | ||
| modelConfig: default-model-config | ||
| systemMessage: | | ||
| You are a friendly assistant living inside an Agent Substrate sandbox. | ||
| When asked who you are, say "I am hello-substrate, a Go ADK declarative | ||
| agent running inside a gVisor actor." | ||
| platform: substrate | ||
| substrate: | ||
| workerPoolRef: | ||
| name: kagent-default |
Comment on lines
+303
to
+305
| You can run a declarative agent in an isolated sandbox by creating a `SandboxAgent` resource instead of a regular `Agent`. A `SandboxAgent` runs on [Agent Substrate](/docs/kagent/concepts/agent-substrate): the kagent controller runs it as a gVisor-sandboxed actor instead of a Deployment, snapshotting it to object storage when idle and rehydrating it on demand. The spec mirrors the `Agent` spec, with a few constraints: sandboxed agents always use the Go ADK runtime, and `spec.skills` and `BYO` agents are not supported. Configure substrate placement with the optional `spec.substrate` field (for example, `workerPoolRef`). | ||
|
|
||
| For setup steps, see the [Agent Sandbox example](/docs/kagent/examples/agent-sandbox). | ||
| For setup steps, see the [Agent Substrate example](/docs/kagent/examples/agent-substrate). |
Comment on lines
17
to
21
| kagent can run workloads on Agent Substrate in two ways: | ||
|
|
||
| - **Declarative agents** — A declarative `Agent` describes its model, instructions, and tools (see [Agents](/docs/kagent/concepts/agents)). Its sandboxed variant, the [`SandboxAgent`](/docs/kagent/resources/api-ref) CRD, lets you run a (Go) declarative agent on Agent Substrate. | ||
| - **AgentHarness** — The [`AgentHarness`](/docs/kagent/concepts/agent-harness) CRD provisions a long-running execution environment. Select Agent Substrate as its runtime by setting `runtime` to `substrate`; kagent then generates a per-harness `ActorTemplate` and creates an `Actor` from it, referencing a `WorkerPool` for capacity. | ||
| - **AgentHarness** — The [`AgentHarness`](/docs/kagent/concepts/agent-harness) CRD provisions a long-running execution environment for a coding agent (OpenClaw or Hermes). It always runs on Agent Substrate: kagent generates a per-harness `ActorTemplate` and creates an `Actor` from it on demand, referencing a `WorkerPool` for capacity. | ||
|
|
artberger
approved these changes
Jun 27, 2026
Collaborator
|
The API doc updates that the copilot review comments mention should be addressed in the auto-gen PR like here: https://github.com/kagent-dev/website/pull/399/changes |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.