From c4e0687b866218b094e955da1000d2a70aee10aa Mon Sep 17 00:00:00 2001 From: Keming Date: Fri, 7 Nov 2025 22:05:32 +0800 Subject: [PATCH] docs: fix all the broken links after the repo migration Signed-off-by: Keming --- CONTRIBUTING.md | 16 ++++++++-------- README.md | 4 ++-- docs/quickstart.md | 10 +++++----- mkdocs.yml | 10 +++++----- pyproject.toml | 6 +++--- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1b287e..e4662c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to `agent-client-protocol-python` +# Contributing to `agentclientprotocol/python-sdk` Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. @@ -9,7 +9,7 @@ You can contribute in many ways: ## Report Bugs -Report bugs at https://github.com/psiace/agent-client-protocol-python/issues +Report bugs at https://github.com/agentclientprotocol/python-sdk/issues If you are reporting a bug, please include: @@ -29,11 +29,11 @@ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to ## Write Documentation -agent-client-protocol-python could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such. +This project could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such. ## Submit Feedback -The best way to send feedback is to file an issue at https://github.com/psiace/agent-client-protocol-python/issues. +The best way to send feedback is to file an issue at https://github.com/agentclientprotocol/python-sdk/issues. If you are proposing a new feature: @@ -44,22 +44,22 @@ If you are proposing a new feature: # Get Started! -Ready to contribute? Here's how to set up `agent-client-protocol-python` for local development. +Ready to contribute? Here's how to set up the project for local development. Please note this documentation assumes you already have `uv` and `Git` installed and ready to go. -1. Fork the `agent-client-protocol-python` repo on GitHub. +1. Fork the `agentclientprotocol/python-sdk` repo on GitHub. 2. Clone your fork locally: ```bash cd -git clone git@github.com:YOUR_NAME/agent-client-protocol-python.git +git clone git@github.com:YOUR_NAME/python-sdk.git ``` 3. Now we need to install the environment. Navigate into the directory ```bash -cd agent-client-protocol-python +cd python-sdk ``` Then, install and activate the environment with: diff --git a/README.md b/README.md index 280bfc4..51f8cfc 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ uv add agent-client-protocol ``` 2. Wire it into your client (e.g. Zed → Agents panel) so stdio is connected; the SDK handles JSON-RPC framing and lifecycle messages. -Prefer a step-by-step walkthrough? Read the [Quickstart guide](docs/quickstart.md) or the hosted docs: https://psiace.github.io/agent-client-protocol-python/. +Prefer a step-by-step walkthrough? Read the [Quickstart guide](docs/quickstart.md) or the hosted docs: https://agentclientprotocol.github.io/python-sdk/. ### Launching from Python @@ -162,7 +162,7 @@ Read more in [docs/contrib.md](docs/contrib.md). ## Documentation -- Project docs (MkDocs): https://psiace.github.io/agent-client-protocol-python/ +- Project docs (MkDocs): https://agentclientprotocol.github.io/python-sdk/ - Local sources: `docs/` - [Quickstart](docs/quickstart.md) - [Contrib helpers](docs/contrib.md) diff --git a/docs/quickstart.md b/docs/quickstart.md index c5bf689..7c9bca7 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -37,7 +37,7 @@ Add an Agent Server entry in `settings.json` (Zed → Settings → Agents panel) "Echo Agent (Python)": { "command": "/abs/path/to/python", "args": [ - "/abs/path/to/agent-client-protocol-python/examples/echo_agent.py" + "/abs/path/to/agentclientprotocol/python-sdk/examples/echo_agent.py" ] } } @@ -103,10 +103,10 @@ class MyAgent(Agent): Hook it up with `AgentSideConnection` inside an async entrypoint and wire it to your client. Refer to: -- [`examples/echo_agent.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/echo_agent.py) for the smallest streaming agent -- [`examples/agent.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/agent.py) for an implementation that negotiates capabilities and streams richer updates -- [`examples/duet.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/duet.py) to see `spawn_agent_process` in action alongside the interactive client -- [`examples/gemini.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/gemini.py) to drive the Gemini CLI (`--experimental-acp`) directly from Python +- [`examples/echo_agent.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/echo_agent.py) for the smallest streaming agent +- [`examples/agent.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/agent.py) for an implementation that negotiates capabilities and streams richer updates +- [`examples/duet.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/duet.py) to see `spawn_agent_process` in action alongside the interactive client +- [`examples/gemini.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/gemini.py) to drive the Gemini CLI (`--experimental-acp`) directly from Python Need builders for common payloads? `acp.helpers` mirrors the Go/TS helper APIs: diff --git a/mkdocs.yml b/mkdocs.yml index f1704dd..05cfdba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,10 +1,10 @@ site_name: Agent Client Protocol - Python SDK -repo_url: https://github.com/psiace/agent-client-protocol-python -site_url: https://psiace.github.io/agent-client-protocol-python +repo_url: https://github.com/agentclientprotocol/python-sdk +site_url: https://agentclientprotocol.github.io/python-sdk site_description: A Python implement of Agent Client Protocol (ACP, by Zed Industries) site_author: Chojan Shang edit_uri: edit/main/docs/ -repo_name: psiace/agent-client-protocol-python +repo_name: agentclientprotocol/python-sdk copyright: Maintained by psiace. nav: @@ -43,9 +43,9 @@ theme: extra: social: - icon: fontawesome/brands/github - link: https://github.com/psiace/agent-client-protocol-python + link: https://github.com/agentclientprotocol/python-sdk - icon: fontawesome/brands/python - link: https://pypi.org/project/agent-client-protocol-python + link: https://pypi.org/project/agent-client-protocol markdown_extensions: - toc: diff --git a/pyproject.toml b/pyproject.toml index 01c1d30..8f538a6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,9 +23,9 @@ dependencies = [ [project.urls] -Homepage = "https://psiace.github.io/agent-client-protocol-python/" -Repository = "https://github.com/psiace/agent-client-protocol-python" -Documentation = "https://psiace.github.io/agent-client-protocol-python/" +Homepage = "https://agentclientprotocol.github.io/python-sdk/" +Repository = "https://github.com/agentclientprotocol/python-sdk" +Documentation = "https://agentclientprotocol.github.io/python-sdk/" [dependency-groups] dev = [