diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4cb9e0e..b86bcb0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,4 +152,4 @@ pages by hand. When you push your branch, the `publish-docs.yml` workflow builds the site and deploys to the `gh-pages` branch on push to `master`. The published site is at -**https://ai-agent-assembly.github.io/node-sdk/**. +**https://docs.agent-assembly.com/node-sdk/**. diff --git a/README.md b/README.md index b94cf506..76b13a5f 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ selects ESM or CJS automatically based on how the consumer imports it. `initAssembly()` registers the LangChain callback handler and auto-wraps the configured tools, so each is checked against gateway policy before invocation. For more frameworks and the lower-level `withAssembly()` wrapper, see the **Examples** guide on the -[documentation site](https://ai-agent-assembly.github.io/node-sdk/). +[documentation site](https://docs.agent-assembly.com/node-sdk/). ## Supported Node.js versions @@ -129,11 +129,11 @@ binding requires Node 18.18 or newer. each framework's optional peer dependency, supported version range, and current status (including the [known Vercel AI SDK caveat](https://lightning-dust-mite.atlassian.net/browse/AAASM-3532)) — is the **authoritative** reference and lives on the docs site: -[Framework compatibility](https://ai-agent-assembly.github.io/node-sdk/compatibility-versioning/compatibility). +[Framework compatibility](https://docs.agent-assembly.com/node-sdk/compatibility-versioning/compatibility). For the product-wide, cross-SDK index/hub that links every language SDK's matrix, see the core documentation: -[Framework compatibility index](https://ai-agent-assembly.github.io/agent-assembly/stable/reference/framework-compatibility.html) +[Framework compatibility index](https://docs.agent-assembly.com/core/stable/reference/framework-compatibility.html) (the `/stable/` link goes live at GA). ## How it works @@ -163,7 +163,7 @@ call is checked against policy before it runs. Type-only exports (`AssemblyConfig`, `AssemblyContext`, `AssemblyMode`, `EnforcementMode`, `ToolMap`, `GatewayClient`, the `Gateway*` governance types, and friends) are documented in -the [API reference](https://ai-agent-assembly.github.io/node-sdk/api-reference). +the [API reference](https://docs.agent-assembly.com/node-sdk/api-reference). ## Governing tools offline @@ -237,7 +237,7 @@ tests/ # unit + architecture tests ``` For how these layers fit together, see the -[Architecture guide](https://ai-agent-assembly.github.io/node-sdk/core-concepts/architecture). +[Architecture guide](https://docs.agent-assembly.com/node-sdk/core-concepts/architecture). ## Building the native binding @@ -284,7 +284,7 @@ CI verifies the published shape with: Full guides, architecture deep-dives, and the complete API reference are published at: -**https://ai-agent-assembly.github.io/node-sdk/** +**https://docs.agent-assembly.com/node-sdk/** The site is built from the `docs/` (content) and `website/` (Docusaurus app) directories and is re-published on every push to `master` via the `publish-docs.yml` workflow. @@ -298,7 +298,7 @@ across all SDKs. | Project | What it is | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [agent-assembly](https://github.com/ai-agent-assembly/agent-assembly) | Core Rust runtime — gateway, policy engine, proxy, eBPF, CLI (`aasm`). The protocol specification lives here. | -| [Documentation site](https://ai-agent-assembly.github.io/agent-assembly-docs/) | Canonical, cross-repo documentation for the whole platform. | +| [Documentation site](https://docs.agent-assembly.com/) | Canonical, cross-repo documentation for the whole platform. | | [python-sdk](https://github.com/ai-agent-assembly/python-sdk) | Sibling SDK for Python. | | [go-sdk](https://github.com/ai-agent-assembly/go-sdk) | Sibling SDK for Go. | | [agent-assembly-examples](https://github.com/ai-agent-assembly/agent-assembly-examples) | Runnable examples — learn by running small, framework-specific Node.js/TypeScript (and Python/Go) samples for policy enforcement, approvals, audit, trace, and runtime workflows. | diff --git a/docs/01-introduction/index.md b/docs/01-introduction/index.md index 28b48a99..f137cd95 100644 --- a/docs/01-introduction/index.md +++ b/docs/01-introduction/index.md @@ -59,10 +59,10 @@ fit, read **[Core Concepts](../03-core-concepts/index.md)**. - [agent-assembly](https://github.com/ai-agent-assembly/agent-assembly) — the core Rust runtime and the home of the protocol specification. Its - [documentation site](https://ai-agent-assembly.github.io/agent-assembly/) is the best + [documentation site](https://docs.agent-assembly.com/core/) is the best place to understand the gateway, the policy engine, and the three interception layers this SDK plugs into. -- [Canonical documentation hub](https://ai-agent-assembly.github.io/agent-assembly-docs/) +- [Canonical documentation hub](https://docs.agent-assembly.com/) — cross-repo platform documentation and the core↔SDK compatibility matrix. - [Organization profile](https://github.com/ai-agent-assembly) — every Agent Assembly repository and its status. diff --git a/docs/03-core-concepts/index.md b/docs/03-core-concepts/index.md index 76fd75f9..7bac6ea8 100644 --- a/docs/03-core-concepts/index.md +++ b/docs/03-core-concepts/index.md @@ -25,8 +25,8 @@ so the gateway evaluates each call before it executes. The gateway, the policy engine, and the audit trail live in the core runtime. For the platform-level picture — how the gateway renders decisions and how this SDK relates to the sidecar-proxy and eBPF layers — see the core -[Architecture](https://ai-agent-assembly.github.io/agent-assembly/latest/architecture/) and -[Security Model](https://ai-agent-assembly.github.io/agent-assembly/latest/security/overview.html) docs. +[Architecture](https://docs.agent-assembly.com/core/latest/architecture/) and +[Security Model](https://docs.agent-assembly.com/core/latest/security/overview.html) docs. ## The napi-rs native FFI diff --git a/docs/05-configuration/index.md b/docs/05-configuration/index.md index bfd76e8d..83886931 100644 --- a/docs/05-configuration/index.md +++ b/docs/05-configuration/index.md @@ -78,7 +78,7 @@ time. See [Troubleshooting](../08-troubleshooting/index.md) for the recovery pat The `aasm` binary and the gateway it starts are part of the core runtime. For the full list of gateway subcommands and flags, see the core -[CLI Reference](https://ai-agent-assembly.github.io/agent-assembly/latest/cli/overview.html). +[CLI Reference](https://docs.agent-assembly.com/core/latest/cli/overview.html). ## `AssemblyConfig` fields diff --git a/docs/07-compatibility-versioning/compatibility.md b/docs/07-compatibility-versioning/compatibility.md index 1f895f9c..647c7000 100644 --- a/docs/07-compatibility-versioning/compatibility.md +++ b/docs/07-compatibility-versioning/compatibility.md @@ -54,7 +54,7 @@ above reflects the intended support floor once that bug is fixed. This page is the **authoritative** reference for the Node SDK's framework support. The product-wide, cross-SDK **index/hub** that points at each language SDK's matrix lives in the core documentation: -[Framework compatibility](https://ai-agent-assembly.github.io/agent-assembly/stable/reference/framework-compatibility.html) +[Framework compatibility](https://docs.agent-assembly.com/core/stable/reference/framework-compatibility.html) (the `/stable/` link goes live at GA). ## Package manager @@ -89,5 +89,5 @@ Practical guidance: The cross-repo **core ↔ SDK compatibility matrix** — which SDK versions pair with which core runtime releases across all language SDKs — is published on the -[Agent Assembly documentation hub](https://ai-agent-assembly.github.io/agent-assembly-docs/). +[Agent Assembly documentation hub](https://docs.agent-assembly.com/). Consult it when running a standalone gateway you upgrade independently of the SDK. diff --git a/website/README.md b/website/README.md index 734e18e2..7ef84dd7 100644 --- a/website/README.md +++ b/website/README.md @@ -1,7 +1,7 @@ # Documentation site for `@agent-assembly/sdk` This directory contains the Docusaurus 3 application that builds the public documentation -site at . +site at . Markdown content lives **outside this directory**, at `../docs/`. The Docusaurus app reads it via `docs.path: '../docs'`. The TypeDoc-generated API reference is regenerated by diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 521281e6..43b70a8f 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -247,19 +247,19 @@ const config: Config = { items: [ { label: "Docs Hub", - href: "https://ai-agent-assembly.github.io/agent-assembly-docs/", + href: "https://docs.agent-assembly.com/", }, { label: "Python SDK", - href: "https://ai-agent-assembly.github.io/python-sdk/", + href: "https://docs.agent-assembly.com/python-sdk/", }, { label: "Node SDK", - href: "https://ai-agent-assembly.github.io/node-sdk/", + href: "https://docs.agent-assembly.com/node-sdk/", }, { label: "Go SDK", - href: "https://ai-agent-assembly.github.io/go-sdk/", + href: "https://docs.agent-assembly.com/go-sdk/", }, ], }, @@ -300,19 +300,19 @@ const config: Config = { items: [ { label: "Docs Hub", - href: "https://ai-agent-assembly.github.io/agent-assembly-docs/", + href: "https://docs.agent-assembly.com/", }, { label: "Python SDK", - href: "https://ai-agent-assembly.github.io/python-sdk/", + href: "https://docs.agent-assembly.com/python-sdk/", }, { label: "Node SDK", - href: "https://ai-agent-assembly.github.io/node-sdk/", + href: "https://docs.agent-assembly.com/node-sdk/", }, { label: "Go SDK", - href: "https://ai-agent-assembly.github.io/go-sdk/", + href: "https://docs.agent-assembly.com/go-sdk/", }, ], },