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
6 changes: 5 additions & 1 deletion .github/workflows/docs-hygiene.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ jobs:
grep -q '<a href="./README.md">English</a> · <strong>简体中文</strong>' 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
Expand Down
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

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

Staging remains the public testnet sandbox for first calls and integration tests: <https://staging.synapse-network.ai/docs>.
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: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md>
- Java/JVM SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md>
- .NET SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md>
- 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>

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.

Expand Down
28 changes: 13 additions & 15 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 验证每次调用与结算结果。
Expand All @@ -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 自动发现服务并开始工作。

Expand Down Expand Up @@ -100,19 +100,17 @@ SynapseNetwork 采用严格的环境隔离来保护资金安全。

这个仓库是 GitHub 流量入口、Agent 可读索引,以及公开文档源码镜像仓;完整产品化文档仍然在生产文档站点:

- 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>
- 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>

Staging 仍是公开测试网沙盒,用于首次调用和集成测试:<https://staging.synapse-network.ai/docs>。
更多 SDK 指南位于生产文档站:

Go、Java/JVM 和 .NET 的预览版 SDK 指南在产品文档页面生成前,先链接到官方 SDK 仓库:

- Go SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/go_integration.md>
- Java/JVM SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/java_integration.md>
- .NET SDK: <https://github.com/SynapseNetworkAI/Synapse-Network-Sdk/blob/main/docs/sdk/dotnet_integration.md>
- 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>

公开 docs 页面可以把 “Open in GitHub” 指向这里做源码查看,但 V1 暂不展示 “Edit this page”,因为当前仓库还不是渲染文档页面的唯一权威源码。文档源码同源完成前,请先通过 GitHub Issues 反馈。

Expand Down
6 changes: 1 addition & 5 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
6 changes: 1 addition & 5 deletions docs/contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 1 addition & 5 deletions docs/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

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

Expand Down
15 changes: 7 additions & 8 deletions docs/sdk.md
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 4 additions & 8 deletions examples/dashboard-agent-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -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。
Expand All @@ -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
8 changes: 2 additions & 6 deletions examples/python-first-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 2 additions & 6 deletions examples/typescript-first-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
23 changes: 11 additions & 12 deletions llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading