From 61465ae2a1527d0298e431a6dbdfc9da7e201a7b Mon Sep 17 00:00:00 2001 From: Bryant Liu Date: Sun, 5 Jul 2026 20:10:08 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=97=20(docs):=20Repoint=20doc=20refere?= =?UTF-8?q?nces=20+=20mkdocs=20site=5Furl=20to=20canonical=20host?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace GitHub-Pages doc URLs (ai-agent-assembly.github.io/*) with the canonical docs.agent-assembly.com host across README, docs pages, examples, mkdocs.yml (site_url + nav links), and the deployment-summary BASE_URL in the documentation/backfill workflows. repo_url and the gh-pages deploy mechanics are untouched; third-party github.io links are left as-is. Refs AAASM-4160 --- .github/workflows/docs-backfill.yaml | 2 +- .github/workflows/documentation.yaml | 4 ++-- README.md | 14 +++++++------- docs/compatibility/frameworks.md | 2 +- docs/compatibility/index.md | 2 +- docs/compatibility/release-process.md | 2 +- docs/concepts/index.md | 4 ++-- docs/configuration.md | 4 ++-- docs/index.md | 4 ++-- docs/quick-start.md | 2 +- examples/README.md | 2 +- examples/type_checking/README.md | 2 +- mkdocs.yml | 10 +++++----- 13 files changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/workflows/docs-backfill.yaml b/.github/workflows/docs-backfill.yaml index 077d8e04..e7a27838 100644 --- a/.github/workflows/docs-backfill.yaml +++ b/.github/workflows/docs-backfill.yaml @@ -97,7 +97,7 @@ jobs: - name: Deployment summary env: RELEASE_TAG: ${{ inputs.release_tag }} - BASE_URL: "https://ai-agent-assembly.github.io/python-sdk/" + BASE_URL: "https://docs.agent-assembly.com/python-sdk/" run: | { echo "## ๐Ÿ“š Release documentation backfilled" diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 5e7c204b..45aa0c4d 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -232,7 +232,7 @@ jobs: - name: Deployment summary env: - BASE_URL: "https://ai-agent-assembly.github.io/python-sdk/" + BASE_URL: "https://docs.agent-assembly.com/python-sdk/" run: | { echo "## ๐Ÿ“š Release documentation deployed" @@ -315,7 +315,7 @@ jobs: - name: Republish summary env: - BASE_URL: "https://ai-agent-assembly.github.io/python-sdk/" + BASE_URL: "https://docs.agent-assembly.com/python-sdk/" TARGET: ${{ inputs.target }} RELEASE_TAG: ${{ inputs.release_tag }} run: | diff --git a/README.md b/README.md index 29392d24..f6524dd9 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Python framework compatibility is documented **authoritatively in the SDK docs** adapters and the ranges they advertise via `get_supported_versions()` are the source of truth (Python-specific detail, version-sync policy, and the Pydantic AI hook-point note live there). The core docs provide a cross-SDK -[index/hub](https://ai-agent-assembly.github.io/agent-assembly/stable/reference/framework-compatibility.html) +[index/hub](https://docs.agent-assembly.com/core/stable/reference/framework-compatibility.html) that links out to each SDK's own page (Python here, plus Node and Go) โ€” an index, not the canonical matrix (a `/stable/` link โ€” it 404s until the first GA release, by design). @@ -62,7 +62,7 @@ PyPI from the `0.0.x` line (the version badge above reflects the current release version (`agent-assembly==0.0.x`) if you need a stable contract. - **Releases** โ€” [PyPI release history](https://pypi.org/project/agent-assembly/#history) ยท [GitHub releases](https://github.com/ai-agent-assembly/python-sdk/releases) -- **Changelog** โ€” tracked via [commits to `master`](https://github.com/ai-agent-assembly/python-sdk/commits/master) until the first tagged `1.0` release; see the [release notes](https://ai-agent-assembly.github.io/python-sdk/latest/release-notes/) page. +- **Changelog** โ€” tracked via [commits to `master`](https://github.com/ai-agent-assembly/python-sdk/commits/master) until the first tagged `1.0` release; see the [release notes](https://docs.agent-assembly.com/python-sdk/latest/release-notes/) page. - **Stability** โ€” the `init_assembly()` entry point and the exception hierarchy are the most stable surface; framework adapters and the native fast path may evolve faster. ## Requirements @@ -253,12 +253,12 @@ AAASM_RUN_MATURIN_TESTS=1 uv run pytest test/integration/test_native_core_maturi ## Documentation -- **Project docs (rendered)** โ€” https://ai-agent-assembly.github.io/python-sdk/ *(versioned via `mike`; pick `latest` or `stable` from the version selector)* +- **Project docs (rendered)** โ€” https://docs.agent-assembly.com/python-sdk/ *(versioned via `mike`; pick `latest` or `stable` from the version selector)* - **Quick Start** โ€” [source](./docs/quick-start.md) โ€” install and govern your first agent in five minutes (offline LangChain example). - **Core Concepts** โ€” [source](./docs/concepts/index.md) โ€” the adapter pattern, native FFI vs. pure-Python, the `init_assembly()` lifecycle, and modes/enforcement. Deep dive in [Architecture](./docs/concepts/architecture.md). - **Guides** โ€” [Framework examples](./docs/guides/framework-examples.md), [Handling allow/deny decisions](./docs/guides/handling-decisions.md), [Type checking](./docs/guides/type-checking.md). - **Configuration** โ€” [source](./docs/configuration.md) โ€” gateway URL / API-key resolution, runtime modes, enforcement modes. -- **API reference** โ€” [rendered](https://ai-agent-assembly.github.io/python-sdk/latest/api-reference/) / [source](./docs/api-reference/index.md) โ€” auto-generated from package docstrings via `mkdocstrings`. Per-module pages: [Client](./docs/api-reference/client.md), [Exceptions](./docs/api-reference/exceptions.md), [Models](./docs/api-reference/models.md). +- **API reference** โ€” [rendered](https://docs.agent-assembly.com/python-sdk/latest/api-reference/) / [source](./docs/api-reference/index.md) โ€” auto-generated from package docstrings via `mkdocstrings`. Per-module pages: [Client](./docs/api-reference/client.md), [Exceptions](./docs/api-reference/exceptions.md), [Models](./docs/api-reference/models.md). - **Compatibility & Versioning** โ€” [source](./docs/compatibility/index.md) โ€” Python versions, core-runtime tracking, [release process](./docs/compatibility/release-process.md), and [ADRs](./docs/development/adr/). - **Troubleshooting** โ€” [source](./docs/troubleshooting.md) โ€” common integration errors and fixes. @@ -271,7 +271,7 @@ directly: | Project | What it is | | --- | --- | | [agent-assembly](https://github.com/ai-agent-assembly/agent-assembly) | **Core runtime** โ€” gateway, policy engine, eBPF, proxy, CLI. Also home of the protocol specification. | -| [Documentation site](https://ai-agent-assembly.github.io/agent-assembly-docs/) | Canonical, cross-repo documentation hub for the whole project. | +| [Documentation site](https://docs.agent-assembly.com/) | Canonical, cross-repo documentation hub for the whole project. | | [python-sdk](https://github.com/ai-agent-assembly/python-sdk) | **This repo** โ€” the Python SDK. | | [node-sdk](https://github.com/ai-agent-assembly/node-sdk) ยท [go-sdk](https://github.com/ai-agent-assembly/go-sdk) | Sibling SDKs for TypeScript/Node and Go. | | [homebrew-tap](https://github.com/ai-agent-assembly/homebrew-tap) | Homebrew tap for installing the `aasm` runtime CLI. | @@ -280,7 +280,7 @@ directly: The protocol specification and gateway behaviour the SDK targets live in the core runtime monorepo; see its [README](https://github.com/ai-agent-assembly/agent-assembly#readme) for the spec and architecture. For how this SDK stays in sync with the core runtime, see the -[Compatibility & Versioning](https://ai-agent-assembly.github.io/python-sdk/latest/compatibility/) +[Compatibility & Versioning](https://docs.agent-assembly.com/python-sdk/latest/compatibility/) docs. ## Contributing @@ -290,7 +290,7 @@ Please read [**CONTRIBUTING.md**](./CONTRIBUTING.md) before opening a PR โ€” it ## Support - **Bugs & feature requests** โ€” open a [GitHub issue](https://github.com/ai-agent-assembly/python-sdk/issues). -- **Questions & usage help** โ€” start with the [documentation site](https://ai-agent-assembly.github.io/python-sdk/) and the [Troubleshooting](https://ai-agent-assembly.github.io/python-sdk/latest/troubleshooting/) guide, then open an issue if you're still stuck. +- **Questions & usage help** โ€” start with the [documentation site](https://docs.agent-assembly.com/python-sdk/) and the [Troubleshooting](https://docs.agent-assembly.com/python-sdk/latest/troubleshooting/) guide, then open an issue if you're still stuck. - **Security** โ€” please **do not** file public issues for vulnerabilities. Report them privately via [GitHub Security Advisories](https://github.com/ai-agent-assembly/python-sdk/security/advisories/new). ## License diff --git a/docs/compatibility/frameworks.md b/docs/compatibility/frameworks.md index 578a9a51..3e212705 100644 --- a/docs/compatibility/frameworks.md +++ b/docs/compatibility/frameworks.md @@ -22,7 +22,7 @@ compatibility page (this one for Python, plus the Node and Go equivalents). It i index, not the canonical matrix โ€” each SDK's page is authoritative for its own language, because the adapters live in the SDK: -- **[Cross-SDK framework-compatibility index โ†’](https://ai-agent-assembly.github.io/agent-assembly/stable/reference/framework-compatibility.html)** +- **[Cross-SDK framework-compatibility index โ†’](https://docs.agent-assembly.com/core/stable/reference/framework-compatibility.html)** !!! note "The `/stable/` link 404s until GA" That URL points at the `stable` documentation channel, which only activates at the diff --git a/docs/compatibility/index.md b/docs/compatibility/index.md index 8c1895ef..b4a1becc 100644 --- a/docs/compatibility/index.md +++ b/docs/compatibility/index.md @@ -24,7 +24,7 @@ The Python SDK is one of several clients (alongside the Node and Go SDKs) for th Assembly **core runtime**. The org-wide compatibility matrix โ€” which SDK versions are wire-compatible with which core-runtime release โ€” lives on the documentation hub: -- **[Documentation Hub โ†’](https://ai-agent-assembly.github.io/agent-assembly-docs/)** โ€” the +- **[Documentation Hub โ†’](https://docs.agent-assembly.com/)** โ€” the cross-component compatibility matrix and the protocol specification. For the Python-specific detail โ€” how the pure-Python client stays forward/backward tolerant diff --git a/docs/compatibility/release-process.md b/docs/compatibility/release-process.md index 51e1666a..8ed6b10e 100644 --- a/docs/compatibility/release-process.md +++ b/docs/compatibility/release-process.md @@ -46,7 +46,7 @@ dry-run without publishing. Docs are versioned with [`mike`](https://github.com/jimporter/mike): every push to `master` deploys to **`latest`**, and a release promotes to **`stable`**. Readers switch versions with -the selector at the top of the [documentation site](https://ai-agent-assembly.github.io/python-sdk/). +the selector at the top of the [documentation site](https://docs.agent-assembly.com/python-sdk/). ## Release notes diff --git a/docs/concepts/index.md b/docs/concepts/index.md index 94953a97..1d92af48 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -19,8 +19,8 @@ monkey-patch layer and the exact bootstrap/teardown order โ€” see The SDK is the in-process (fastest) layer of a three-layer interception model. For how it fits alongside the sidecar proxy and eBPF layers, and the trust boundary the gateway enforces, see the core -[Architecture](https://ai-agent-assembly.github.io/agent-assembly/architecture/) and -[Security Model](https://ai-agent-assembly.github.io/agent-assembly/security/) docs. +[Architecture](https://docs.agent-assembly.com/core/architecture/) and +[Security Model](https://docs.agent-assembly.com/core/security/) docs. ## The adapter pattern diff --git a/docs/configuration.md b/docs/configuration.md index d6e0b01b..68aee065 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -58,8 +58,8 @@ This means a local development loop often needs no arguments at all โ€” start a For the full gateway configuration surface (policy files, budgets, mTLS) and the complete `aasm` CLI reference, see the core -[Gateway configuration](https://ai-agent-assembly.github.io/agent-assembly/configuration/) and -[CLI reference](https://ai-agent-assembly.github.io/agent-assembly/cli/) docs. +[Gateway configuration](https://docs.agent-assembly.com/core/configuration/) and +[CLI reference](https://docs.agent-assembly.com/core/cli/) docs. ```bash export AAASM_GATEWAY_URL="https://gateway.example.com" diff --git a/docs/index.md b/docs/index.md index 8d87fddd..ed82ca32 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,8 +16,8 @@ You keep writing agents the way you always have. The SDK is the seatbelt you cli > **New to Agent Assembly?** This SDK is one of three interception layers in the broader > platform. For the product overview, the gateway, and the policy model, see the core -> [Agent Assembly documentation](https://ai-agent-assembly.github.io/agent-assembly/) and the -> [documentation hub](https://ai-agent-assembly.github.io/agent-assembly-docs/). +> [Agent Assembly documentation](https://docs.agent-assembly.com/core/) and the +> [documentation hub](https://docs.agent-assembly.com/). ## What it wraps diff --git a/docs/quick-start.md b/docs/quick-start.md index 52503698..6c74335c 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -37,7 +37,7 @@ decisions. You have three options: provides it). - **Run one yourself** with `aasm start --mode local --foreground` in a separate terminal. For a full gateway walkthrough, see the core - [Run the gateway](https://ai-agent-assembly.github.io/agent-assembly/getting-started/) guide. + [Run the gateway](https://docs.agent-assembly.com/core/getting-started/) guide. - **Pass an explicit URL**, as the example below does. See [Configuration](configuration.md) for the full URL/key resolution chain (`7391` is the diff --git a/examples/README.md b/examples/README.md index 874ef968..bea93955 100644 --- a/examples/README.md +++ b/examples/README.md @@ -12,7 +12,7 @@ whether it runs as-is or needs a reachable gateway. The canonical validated end-to-end example is the **LangChain ReAct quick start** in the repository [README](../README.md#quick-start) โ€” it runs fully offline against a mock LLM with no -gateway or API keys. The [Framework examples](https://ai-agent-assembly.github.io/python-sdk/latest/usage/framework-examples/) +gateway or API keys. The [Framework examples](https://docs.agent-assembly.com/python-sdk/latest/usage/framework-examples/) guide lists every supported framework and which ones have a vendored runnable example yet. ## Running an example diff --git a/examples/type_checking/README.md b/examples/type_checking/README.md index c6c9ba80..2a8be7b9 100644 --- a/examples/type_checking/README.md +++ b/examples/type_checking/README.md @@ -33,5 +33,5 @@ Call-stack nodes: 1 - Constructing `AgentConfig`, `AuditEvent`, and a nested `CallStackNode` tree with the `CallStackNodeKind` literal โ€” all statically checked. -See the [Type checking guide](https://ai-agent-assembly.github.io/python-sdk/latest/usage/type-checking/) +See the [Type checking guide](https://docs.agent-assembly.com/python-sdk/latest/usage/type-checking/) for the full public type surface and how to type-check your own integration. diff --git a/mkdocs.yml b/mkdocs.yml index f7b25cb7..fc9dfa87 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ # Project information site_name: Agent Assembly Python SDK -site_url: https://ai-agent-assembly.github.io/python-sdk/ +site_url: https://docs.agent-assembly.com/python-sdk/ site_author: Agent Assembly Team site_description: >- Python SDK for AI Agent Assembly โ€” a governance-native runtime for AI agents. @@ -208,10 +208,10 @@ extra: # Page tree nav: - - Docs Hub: https://ai-agent-assembly.github.io/agent-assembly-docs/ - - Python SDK: https://ai-agent-assembly.github.io/python-sdk/ - - Node SDK: https://ai-agent-assembly.github.io/node-sdk/ - - Go SDK: https://ai-agent-assembly.github.io/go-sdk/ + - Docs Hub: https://docs.agent-assembly.com/ + - Python SDK: https://docs.agent-assembly.com/python-sdk/ + - Node SDK: https://docs.agent-assembly.com/node-sdk/ + - Go SDK: https://docs.agent-assembly.com/go-sdk/ - Introduction: index.md - Quick Start: quick-start.md - Core Concepts: