From 440a6b3eaf177c548abdfc71a55dcd0f5c1cfecc Mon Sep 17 00:00:00 2001 From: cc-mac-mini Date: Fri, 15 May 2026 14:19:56 +0800 Subject: [PATCH 1/2] Canonicalize docs domain links --- README.md | 28 +++++++++++++--------------- README.zh-CN.md | 28 +++++++++++++--------------- docs/concepts.md | 6 +----- docs/contracts.md | 6 +----- docs/credentials.md | 6 +----- docs/github-growth.md | 8 ++------ docs/sdk.md | 15 +++++++-------- examples/dashboard-agent-key.md | 12 ++++-------- examples/python-first-call.md | 8 ++------ examples/typescript-first-call.md | 8 ++------ llms.txt | 23 +++++++++++------------ 11 files changed, 57 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index d30a468..96d7f48 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ AI-native API commerce, payment, and settlement infrastructure for agents. -[Read the Full Documentation](https://synapse-network.ai/docs) · -[Python SDK](https://synapse-network.ai/docs/sdk/python) · -[TypeScript SDK](https://synapse-network.ai/docs/sdk/typescript) · +[Read the Full Documentation](https://docs.synapse-network.ai/) · +[Python SDK](https://docs.synapse-network.ai/sdks/python) · +[TypeScript SDK](https://docs.synapse-network.ai/sdks/typescript) · [SDK Repository](https://github.com/SynapseNetworkAI/Synapse-Network-Sdk) SynapseNetwork lets agents discover services, call APIs through the platform, pay small USDC-priced amounts through blockchain-backed settlement, and verify every invocation with receipts. @@ -21,7 +21,7 @@ SynapseNetwork lets agents discover services, call APIs through the platform, pa Step 1: Get your Agent Key. -Open the **[Synapse Gateway Dashboard (Testnet Sandbox)](https://staging.synapse-network.ai)**, connect your wallet, and generate an Agent Key that starts with `agt_`. +Open the **[Synapse Dashboard](https://www.synapse-network.ai)**, connect your wallet, and generate an Agent Key that starts with `agt_`. Step 2: Let your agent discover and work. @@ -100,19 +100,17 @@ The most important rule: agent runtime code should use `SynapseClient`, not owne This repository is the GitHub funnel, agent-readable index, and public-source mirror for docs pages that expose `Open in GitHub`. The polished product documentation still lives on the production docs site: -- SDK hub: -- Python SDK: -- TypeScript SDK: -- Concepts: -- Contracts: +- SDK hub: +- Python SDK: +- TypeScript SDK: +- Concepts: +- Contracts: -Staging remains the public testnet sandbox for first calls and integration tests: . +Additional SDK guides live on the production docs site: -Preview SDK guides for Go, Java/JVM, and .NET live in the official SDK repository until product docs pages are generated: - -- Go SDK: -- Java/JVM SDK: -- .NET SDK: +- Go SDK: +- Java/JVM SDK: +- .NET SDK: Public docs pages may link here for source viewing, but V1 still does not expose "Edit this page" flows because this repository is not yet the canonical authoring source for rendered docs. Please use GitHub Issues for docs feedback until docs-source sync lands. diff --git a/README.zh-CN.md b/README.zh-CN.md index a8260b2..37b6f1c 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -10,9 +10,9 @@ 面向 AI Agent 的 API 调用、支付与结算基础设施。 -[阅读完整文档](https://synapse-network.ai/docs) · -[Python SDK](https://synapse-network.ai/docs/sdk/python) · -[TypeScript SDK](https://synapse-network.ai/docs/sdk/typescript) · +[阅读完整文档](https://docs.synapse-network.ai/) · +[Python SDK](https://docs.synapse-network.ai/sdks/python) · +[TypeScript SDK](https://docs.synapse-network.ai/sdks/typescript) · [SDK 仓库](https://github.com/SynapseNetworkAI/Synapse-Network-Sdk) SynapseNetwork 让 Agent 可以发现服务、通过平台调用接口、用区块链支持的 USDC 完成小额付款，并通过 receipt 验证每次调用与结算结果。 @@ -21,7 +21,7 @@ SynapseNetwork 让 Agent 可以发现服务、通过平台调用接口、用区 步骤 1：获取 Agent Key。 -打开 **[Synapse Gateway Dashboard（测试网沙盒）](https://staging.synapse-network.ai)**，连接钱包，并生成一个以 `agt_` 开头的 Agent Key。 +打开 **[Synapse Dashboard](https://www.synapse-network.ai)**，连接钱包，并生成一个以 `agt_` 开头的 Agent Key。 步骤 2：让 Agent 自动发现服务并开始工作。 @@ -100,19 +100,17 @@ SynapseNetwork 采用严格的环境隔离来保护资金安全。 这个仓库是 GitHub 流量入口、Agent 可读索引，以及公开文档源码镜像仓；完整产品化文档仍然在生产文档站点： -- SDK hub: -- Python SDK: -- TypeScript SDK: -- Concepts: -- Contracts: +- SDK hub: +- Python SDK: +- TypeScript SDK: +- Concepts: +- Contracts: -Staging 仍是公开测试网沙盒，用于首次调用和集成测试：。 +更多 SDK 指南位于生产文档站： -Go、Java/JVM 和 .NET 的预览版 SDK 指南在产品文档页面生成前，先链接到官方 SDK 仓库： - -- Go SDK: -- Java/JVM SDK: -- .NET SDK: +- Go SDK: +- Java/JVM SDK: +- .NET SDK: 公开 docs 页面可以把 “Open in GitHub” 指向这里做源码查看，但 V1 暂不展示 “Edit this page”，因为当前仓库还不是渲染文档页面的唯一权威源码。文档源码同源完成前，请先通过 GitHub Issues 反馈。 diff --git a/docs/concepts.md b/docs/concepts.md index f9c227d..b5139fa 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -2,11 +2,7 @@ Canonical concepts docs: -https://synapse-network.ai/docs/concepts - -Staging sandbox concepts: - -https://staging.synapse-network.ai/docs/concepts +https://docs.synapse-network.ai/concepts/agent-settlement Important sections: diff --git a/docs/contracts.md b/docs/contracts.md index 19c1874..e3b47e8 100644 --- a/docs/contracts.md +++ b/docs/contracts.md @@ -2,10 +2,6 @@ Canonical contracts docs: -https://synapse-network.ai/docs/contracts - -Staging sandbox contracts: - -https://staging.synapse-network.ai/docs/contracts +https://docs.synapse-network.ai/smart-contracts This repository should link to contracts docs rather than duplicating contract reference content until docs-source sync is implemented. diff --git a/docs/credentials.md b/docs/credentials.md index e739820..420a7a5 100644 --- a/docs/credentials.md +++ b/docs/credentials.md @@ -2,11 +2,7 @@ Canonical credentials docs: -https://synapse-network.ai/docs/concepts#credentials - -Staging sandbox credentials: - -https://staging.synapse-network.ai/docs/concepts#credentials +https://docs.synapse-network.ai/concepts/budget-isolation Agent runtime rule: diff --git a/docs/github-growth.md b/docs/github-growth.md index 677ab8c..d7ccca1 100644 --- a/docs/github-growth.md +++ b/docs/github-growth.md @@ -22,15 +22,11 @@ SynapseNetwork：AI Agent 通过平台调用 API，并通过区块链支持的 U Recommended website: -https://synapse-network.ai/docs +https://docs.synapse-network.ai/ Primary dashboard CTA: -https://synapse-network.ai - -Staging sandbox CTA: - -https://staging.synapse-network.ai +https://www.synapse-network.ai Recommended topics: diff --git a/docs/sdk.md b/docs/sdk.md index 70290a3..6ea7edc 100644 --- a/docs/sdk.md +++ b/docs/sdk.md @@ -1,13 +1,12 @@ # SDK Docs Index -Use the production docs site as the product runbook. Staging remains the sandbox/testnet runbook for first calls. +Use the production docs site as the product runbook. -- SDK hub: https://synapse-network.ai/docs/sdk -- Python SDK: https://synapse-network.ai/docs/sdk/python -- TypeScript SDK: https://synapse-network.ai/docs/sdk/typescript -- Staging sandbox SDK hub: https://staging.synapse-network.ai/docs/sdk -- Go SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md -- Java/JVM SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md -- .NET SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md +- SDK hub: https://docs.synapse-network.ai/sdks +- Python SDK: https://docs.synapse-network.ai/sdks/python +- TypeScript SDK: https://docs.synapse-network.ai/sdks/typescript +- Go SDK: https://docs.synapse-network.ai/sdks/go +- Java/JVM SDK: https://docs.synapse-network.ai/sdks/java +- .NET SDK: https://docs.synapse-network.ai/sdks/dotnet This repository keeps the GitHub billboard, agent prompt rules, and short copyable examples. It is not yet the source of truth for every rendered docs page. diff --git a/examples/dashboard-agent-key.md b/examples/dashboard-agent-key.md index 02e276e..6e86c57 100644 --- a/examples/dashboard-agent-key.md +++ b/examples/dashboard-agent-key.md @@ -4,13 +4,13 @@ The fastest onboarding path is dashboard-issued credentials. 最快接入路径是通过 Dashboard 签发凭据。 -1. Open the Synapse Gateway Dashboard (Testnet Sandbox): https://staging.synapse-network.ai +1. Open the Synapse Dashboard: https://www.synapse-network.ai 2. Connect wallet as the owner. 3. Generate an Agent Key. 4. Copy the key that starts with `agt_`. 5. Give only that Agent Key to the agent runtime. -1. 打开 Synapse Gateway Dashboard（测试网沙盒）：https://staging.synapse-network.ai +1. 打开 Synapse Dashboard：https://www.synapse-network.ai 2. 以 owner 身份连接钱包。 3. 生成 Agent Key。 4. 复制以 `agt_` 开头的 key。 @@ -20,10 +20,6 @@ The agent runtime should not receive owner private keys, wallet mnemonics, or ow Agent 运行时不应该接收 owner 私钥、钱包助记词或 owner JWT。 -Full docs: https://synapse-network.ai/docs/concepts#credentials +Full docs: https://docs.synapse-network.ai/concepts/budget-isolation -Staging sandbox docs: https://staging.synapse-network.ai/docs/concepts#credentials - -完整文档：https://synapse-network.ai/docs/concepts#credentials - -Staging 沙盒文档：https://staging.synapse-network.ai/docs/concepts#credentials +完整文档：https://docs.synapse-network.ai/concepts/budget-isolation diff --git a/examples/python-first-call.md b/examples/python-first-call.md index e291125..4032f20 100644 --- a/examples/python-first-call.md +++ b/examples/python-first-call.md @@ -33,10 +33,6 @@ receipt = client.get_invocation(result.invocation_id) print(receipt.invocation_id, receipt.status, receipt.charged_usdc) ``` -Full runbook: https://synapse-network.ai/docs/sdk/python +Full runbook: https://docs.synapse-network.ai/sdks/python -Staging sandbox runbook: https://staging.synapse-network.ai/docs/sdk/python - -完整接入手册：https://synapse-network.ai/docs/sdk/python - -Staging 沙盒接入手册：https://staging.synapse-network.ai/docs/sdk/python +完整接入手册：https://docs.synapse-network.ai/sdks/python diff --git a/examples/typescript-first-call.md b/examples/typescript-first-call.md index 905fbb1..37f79e7 100644 --- a/examples/typescript-first-call.md +++ b/examples/typescript-first-call.md @@ -36,10 +36,6 @@ const receipt = await client.getInvocation(result.invocationId); console.log(receipt.invocationId, receipt.status, receipt.chargedUsdc); ``` -Full runbook: https://synapse-network.ai/docs/sdk/typescript +Full runbook: https://docs.synapse-network.ai/sdks/typescript -Staging sandbox runbook: https://staging.synapse-network.ai/docs/sdk/typescript - -完整接入手册：https://synapse-network.ai/docs/sdk/typescript - -Staging 沙盒接入手册：https://staging.synapse-network.ai/docs/sdk/typescript +完整接入手册：https://docs.synapse-network.ai/sdks/typescript diff --git a/llms.txt b/llms.txt index 9ad73b6..3685062 100644 --- a/llms.txt +++ b/llms.txt @@ -24,30 +24,29 @@ README 语言结构： 2. `README.zh-CN.md` - Simplified Chinese GitHub billboard and fast agent quickstart. 3. `llm-instructions.md` - compact prompt rules for coding agents. 4. `examples/` - copyable first-call examples. -5. `docs/` - lightweight links into the production docs site, with staging kept as the sandbox. +5. `docs/` - lightweight links into the production docs site. 6. `content/docs/` - one-way public mirror of docs pages rendered from the private main repository. 1. `README.md` - 英文 GitHub 广告牌和快速接入。 2. `README.zh-CN.md` - 简体中文 GitHub 广告牌和快速接入。 3. `llm-instructions.md` - 给编码 Agent 使用的精简提示规则。 4. `examples/` - 可复制的首次调用示例。 -5. `docs/` - 指向 production 文档站的轻量索引，并保留 staging 作为沙盒。 +5. `docs/` - 指向 production 文档站的轻量索引。 6. `content/docs/` - 私有主仓渲染文档页面的一份单向公开镜像。 ## Canonical Product Docs 权威产品文档。 -- Docs home: https://synapse-network.ai/docs -- SDK hub: https://synapse-network.ai/docs/sdk -- Python SDK: https://synapse-network.ai/docs/sdk/python -- TypeScript SDK: https://synapse-network.ai/docs/sdk/typescript -- Concepts: https://synapse-network.ai/docs/concepts -- Contracts: https://synapse-network.ai/docs/contracts -- Staging sandbox docs: https://staging.synapse-network.ai/docs -- Go SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md -- Java/JVM SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md -- .NET SDK guide: https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md +- Docs home: https://docs.synapse-network.ai/ +- SDK hub: https://docs.synapse-network.ai/sdks +- Python SDK: https://docs.synapse-network.ai/sdks/python +- TypeScript SDK: https://docs.synapse-network.ai/sdks/typescript +- Concepts: https://docs.synapse-network.ai/concepts/agent-settlement +- Contracts: https://docs.synapse-network.ai/smart-contracts +- Go SDK: https://docs.synapse-network.ai/sdks/go +- Java/JVM SDK: https://docs.synapse-network.ai/sdks/java +- .NET SDK: https://docs.synapse-network.ai/sdks/dotnet ## V1 Docs Contribution Rule From f21541ff297f5ae8f86a954aa2c76c023948ec9b Mon Sep 17 00:00:00 2001 From: cc-mac-mini Date: Fri, 15 May 2026 14:23:35 +0800 Subject: [PATCH 2/2] Update docs hygiene canonical URL check --- .github/workflows/docs-hygiene.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-hygiene.yml b/.github/workflows/docs-hygiene.yml index d6e4b61..1217e1b 100644 --- a/.github/workflows/docs-hygiene.yml +++ b/.github/workflows/docs-hygiene.yml @@ -20,7 +20,11 @@ jobs: grep -q 'English · 简体中文' README.zh-CN.md grep -q "Read the Full Documentation" README.md grep -q "阅读完整文档" README.zh-CN.md - grep -q "https://staging.synapse-network.ai/docs" README.md + grep -q "https://docs.synapse-network.ai/" README.md + if grep -RInE "https://(staging\.)?synapse-network\.ai/docs|https://docs-staging\.synapse-network\.ai" README.md README.zh-CN.md llms.txt llm-instructions.md docs examples content/docs; then + echo "Found stale public docs URL; use https://docs.synapse-network.ai/" + exit 1 + fi grep -q "SynapseClient" README.md grep -q "public-source mirror" README.md grep -q "公开文档源码镜像仓" README.zh-CN.md