Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/docs-backfill.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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: |
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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
Expand Down Expand Up @@ -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.

Expand All @@ -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. |
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/compatibility/frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/compatibility/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/compatibility/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/type_checking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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:
Expand Down