Skip to content

Commit 9f08fcd

Browse files
committed
docs: add GitHub links to example files in sacp and sacp-proxy
Added clickable links to example files in the crate-level documentation: sacp: - simple_agent.rs - Minimal agent implementation - yolo_one_shot_client.rs - Complete client example sacp-proxy: - minimal.rs - Simplest possible proxy - with_mcp_server.rs - Proxy that adds MCP tools This makes it easier for users reading the docs to navigate directly to the example code on GitHub.
1 parent a1bc556 commit 9f08fcd

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

src/sacp-proxy/src/lib.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,10 @@
8585
//!
8686
//! ## Examples
8787
//!
88-
//! - **`minimal.rs`** - Simplest possible proxy that forwards everything unchanged
89-
//! - **`with_mcp_server.rs`** - Proxy that adds MCP tools to any agent
88+
//! See the [examples directory](https://github.com/symposium-org/symposium-acp/tree/main/src/sacp-proxy/examples):
89+
//!
90+
//! - **[`minimal.rs`](https://github.com/symposium-org/symposium-acp/blob/main/src/sacp-proxy/examples/minimal.rs)** - Simplest possible proxy that forwards everything unchanged
91+
//! - **[`with_mcp_server.rs`](https://github.com/symposium-org/symposium-acp/blob/main/src/sacp-proxy/examples/with_mcp_server.rs)** - Proxy that adds MCP tools to any agent
9092
//!
9193
//! ## How Proxies Work
9294
//!

src/sacp/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
//!
5050
//! You may also enjoy looking at some of these examples:
5151
//!
52-
//! - **`simple_agent.rs`** - Minimal agent implementation
53-
//! - **`yolo_one_shot_client.rs`** - Complete client that spawns an agent and sends a prompt
52+
//! - **[`simple_agent.rs`](https://github.com/symposium-org/symposium-acp/blob/main/src/sacp/examples/simple_agent.rs)** - Minimal agent implementation
53+
//! - **[`yolo_one_shot_client.rs`](https://github.com/symposium-org/symposium-acp/blob/main/src/sacp/examples/yolo_one_shot_client.rs)** - Complete client that spawns an agent and sends a prompt
5454
//! - **[`elizacp`](https://crates.io/crates/elizacp)** - Full working agent with session management (also useful for testing)
5555
//! - **[`sacp-conductor`](https://crates.io/crates/sacp-conductor)** - The "conductor" is an ACP agent that composes proxy components with a final agent.
5656
//!

0 commit comments

Comments
 (0)