Skip to content

Commit 32aef73

Browse files
whoabuddyclaude
whoabuddy
and
claude
authored
Restructure docs as canonical reference layer (#7)
* docs: restructure as canonical reference layer Replace tutorial/guide content with reference documentation that ties together the AIBTC ecosystem. Landing page (aibtc.com) handles getting started; docs.aibtc.com is now the "phone book" for looking things up. New structure: - /directory/ — Services, tools, SDKs, templates, repositories - /reference/tokens/ — Contract addresses, CAIP identifiers, decimals - /reference/networks/ — Mainnet/testnet configs, API endpoints - /glossary/ — Term definitions (unchanged) Removed: - /guides/what-is-x402/ — Landing page covers this better - /guides/services/ — Replaced by /directory/ - /guides/tokens/ — Replaced by /reference/tokens/ Homepage redesigned as navigation hub with quick reference tables. Closes #2 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: flatten navigation and refine content Address review feedback: - Flatten sidebar to one level (no nested Reference group) - Remove redundant reference index page Directory improvements: - AIBTC services pattern: mainnet on aibtc.com, testnet on aibtc.dev - Fix endpoint paths: /docs, /dashboard at base route (not subdomains) - Add Facilitator /health, Biwas /analytics endpoints - Remove redundant repos section (link to github org instead) - Remove redundant external resources (fold key links into More section) Token reference: - Add Circle Xreserve mention for USDCx - Link to Stacks bridging docs - Link to our CAIP-19 PR (ChainAgnostic/namespaces#167) Network reference: - Fix dashboard/docs paths (at base route, not subdomains) Homepage: - Cleaner quick reference tables - Condensed community links Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 57eee63 commit 32aef73

8 files changed

Lines changed: 235 additions & 183 deletions

File tree

‎astro.config.mjs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ export default defineConfig({
2626
{ icon: 'x.com', label: 'X', href: 'https://x.com/aibtcdev' },
2727
],
2828
sidebar: [
29-
{
30-
label: 'Guides',
31-
autogenerate: { directory: 'guides' },
32-
},
29+
{ label: 'Directory', slug: 'directory' },
30+
{ label: 'Tokens', slug: 'reference/tokens' },
31+
{ label: 'Networks', slug: 'reference/networks' },
3332
{ label: 'Glossary', slug: 'glossary' },
3433
],
3534
}),

‎src/content/docs/directory/index.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Directory
3+
description: Services, tools, and templates in the AIBTC ecosystem.
4+
---
5+
6+
## AIBTC Services
7+
8+
All AIBTC services follow the same pattern: **mainnet** on `aibtc.com`, **testnet** on `aibtc.dev`.
9+
10+
| Service | Mainnet | Testnet | Source |
11+
|---------|---------|---------|--------|
12+
| **x402 API** | [x402.aibtc.com](https://x402.aibtc.com) | [x402.aibtc.dev](https://x402.aibtc.dev) | [GitHub](https://github.com/aibtcdev/x402-api) |
13+
| **Sponsor Relay** | [x402-relay.aibtc.com](https://x402-relay.aibtc.com) | [x402-relay.aibtc.dev](https://x402-relay.aibtc.dev) | [GitHub](https://github.com/aibtcdev/x402-sponsor-relay) |
14+
15+
**x402 API endpoints:**
16+
- `/` — Health check
17+
- `/docs` — OpenAPI documentation
18+
- `/dashboard` — Usage stats and analytics
19+
20+
**Sponsor Relay endpoints:**
21+
- `/` — Health check
22+
- `/docs` — OpenAPI documentation
23+
24+
## Ecosystem Services
25+
26+
| Service | URL | Description |
27+
|---------|-----|-------------|
28+
| **STX402** | [stx402.com](https://stx402.com) | x402 endpoint registry ([/docs](https://stx402.com/docs), [/dashboard](https://stx402.com/dashboard)) |
29+
| **x402 Biwas** | [x402.biwas.xyz](https://x402.biwas.xyz) | AI-powered DeFi analytics ([/analytics](https://x402.biwas.xyz/analytics)) |
30+
| **StacksScan** | [scan.stacksx402.com](https://scan.stacksx402.com) | x402 ecosystem explorer |
31+
| **Facilitator** | [facilitator.stacksx402.com/health](https://facilitator.stacksx402.com/health) | Payment verification service |
32+
33+
## Tools & SDKs
34+
35+
| Tool | Description | Links |
36+
|------|-------------|-------|
37+
| **@aibtc/mcp-server** | MCP server for Claude Code — Stacks blockchain tools | [npm](https://www.npmjs.com/package/@aibtc/mcp-server) · [GitHub](https://github.com/aibtcdev/aibtc-mcp-server) |
38+
| **x402-stacks** | TypeScript SDK for x402 payments | [npm](https://www.npmjs.com/package/x402-stacks) · [GitHub](https://github.com/tony1908/x402-stacks-sdk) |
39+
| **Stacks.js** | Official Stacks JavaScript libraries | [Docs](https://stacks.js.org) · [GitHub](https://github.com/hirosystems/stacks.js) |
40+
41+
## Templates
42+
43+
| Template | Description | Source |
44+
|----------|-------------|--------|
45+
| **x402-api** | Cloudflare Workers template for paid endpoints | [GitHub](https://github.com/aibtcdev/x402-api) |
46+
| **x402-crosschain-example** | Express/Hono with EVM + Stacks | [GitHub](https://github.com/aibtcdev/x402-crosschain-example) |
47+
48+
## More
49+
50+
- **All AIBTC repositories:** [github.com/aibtcdev](https://github.com/aibtcdev)
51+
- **x402 Protocol spec:** [x402.org](https://x402.org)
52+
- **Stacks documentation:** [docs.stacks.co](https://docs.stacks.co)
53+
- **Claude Code:** [claude.ai/code](https://claude.ai/code)

‎src/content/docs/guides/services.md‎

Lines changed: 0 additions & 65 deletions
This file was deleted.

‎src/content/docs/guides/tokens.md‎

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎src/content/docs/guides/what-is-x402.md‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎src/content/docs/index.mdx‎

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,45 @@
11
---
2-
title: AIBTC Documentation
3-
description: Documentation for the AIBTC ecosystem - pay-per-use APIs for AI agents.
2+
title: AIBTC Docs
3+
description: Reference documentation for the AIBTC x402 ecosystem.
44
template: splash
55
hero:
6-
tagline: Pay-per-use APIs for AI agents, powered by Bitcoin.
6+
tagline: Reference docs for the x402 ecosystem on Stacks.
77
actions:
8-
- text: Get Started
9-
link: /guides/what-is-x402/
8+
- text: Directory
9+
link: /directory/
1010
icon: right-arrow
11-
- text: GitHub
12-
link: https://github.com/aibtcdev
11+
- text: Start Building
12+
link: https://aibtc.com
1313
icon: external
1414
variant: minimal
1515
---
1616

17-
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
18-
19-
AIBTC builds tools that let AI agents pay for the APIs they use, one request at a time. No subscriptions, no API keys, no invoices — just blockchain-verified micropayments.
20-
21-
## What's in the ecosystem
17+
import { LinkCard, CardGrid } from '@astrojs/starlight/components';
2218

2319
<CardGrid>
24-
<Card title="x402 API" icon="rocket">
25-
Pay-per-use endpoints for AI inference, blockchain data, hashing, and storage. Agents pay with STX, sBTC, or USDCx per request.
26-
</Card>
27-
<Card title="Sponsor Relay" icon="forward-slash">
28-
Gasless transactions for AI agents. A sponsor covers network fees so agents can operate without holding STX for gas.
29-
</Card>
30-
<Card title="StacksScan Explorer" icon="list-format">
31-
Ecosystem explorer for x402 activity, service stats, and network health across the AIBTC infrastructure.
32-
</Card>
33-
<Card title="Supported Tokens" icon="random">
34-
Pay with STX, sBTC, or USDCx. Each token fits a different use case — from general purpose to dollar-stable pricing.
35-
</Card>
20+
<LinkCard title="Directory" href="/directory/" description="Services, tools, SDKs, and templates." />
21+
<LinkCard title="Tokens" href="/reference/tokens/" description="Contract addresses and identifiers." />
22+
<LinkCard title="Networks" href="/reference/networks/" description="Endpoints and configurations." />
23+
<LinkCard title="Glossary" href="/glossary/" description="Term definitions." />
3624
</CardGrid>
3725

38-
## Quick Links
26+
## Quick Reference
3927

40-
<CardGrid>
41-
<LinkCard title="What is x402?" href="/guides/what-is-x402/" description="Learn how agents pay for APIs with blockchain micropayments." />
42-
<LinkCard title="Services & Tools" href="/guides/services/" description="Explore the APIs, relays, and dashboards in the ecosystem." />
43-
<LinkCard title="Supported Tokens" href="/guides/tokens/" description="Compare STX, sBTC, and USDCx and find out where to get them." />
44-
</CardGrid>
28+
### Tokens
29+
30+
| Token | Mainnet Contract | Testnet Contract |
31+
|-------|------------------|------------------|
32+
| **STX** | Native | Native |
33+
| **sBTC** | `SM3VDXK3WZZSA84...sbtc-token` | `ST1F7QA2MDF17S8...sbtc-token` |
34+
| **USDCx** | `SP120SBRBQJ00MC...usdcx` | — |
35+
36+
### Endpoints
37+
38+
| Service | Mainnet | Testnet |
39+
|---------|---------|---------|
40+
| **x402 API** | [x402.aibtc.com](https://x402.aibtc.com) | [x402.aibtc.dev](https://x402.aibtc.dev) |
41+
| **Sponsor Relay** | [x402-relay.aibtc.com](https://x402-relay.aibtc.com) | [x402-relay.aibtc.dev](https://x402-relay.aibtc.dev) |
42+
43+
## Community
44+
45+
- [Weekly Calls](https://www.addevent.com/event/UM20108233) · [Discord](https://discord.gg/5DJaBrf) · [GitHub](https://github.com/aibtcdev) · [X](https://x.com/aibtcdev)

‎src/content/docs/reference/networks.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Networks
3+
description: Mainnet and testnet configurations, endpoints, and identifiers.
4+
---
5+
6+
## Network Overview
7+
8+
| Property | Mainnet | Testnet |
9+
|----------|---------|---------|
10+
| **CAIP-2 ID** | `stacks:1` | `stacks:2147483648` |
11+
| **Chain ID** | `1` | `2147483648` |
12+
| **Address prefix** | `SP` / `SM` | `ST` / `SN` |
13+
| **Block time** | ~5 seconds | ~5 seconds |
14+
| **Bitcoin anchor** | Bitcoin mainnet | Bitcoin testnet |
15+
16+
## AIBTC Endpoints
17+
18+
All AIBTC services: **mainnet** on `aibtc.com`, **testnet** on `aibtc.dev`.
19+
20+
### x402 API
21+
22+
| Endpoint | Mainnet | Testnet |
23+
|----------|---------|---------|
24+
| **Base** | `https://x402.aibtc.com` | `https://x402.aibtc.dev` |
25+
| **Docs** | [/docs](https://x402.aibtc.com/docs) | [/docs](https://x402.aibtc.dev/docs) |
26+
| **Dashboard** | [/dashboard](https://x402.aibtc.com/dashboard) | [/dashboard](https://x402.aibtc.dev/dashboard) |
27+
28+
### Sponsor Relay
29+
30+
| Endpoint | Mainnet | Testnet |
31+
|----------|---------|---------|
32+
| **Base** | `https://x402-relay.aibtc.com` | `https://x402-relay.aibtc.dev` |
33+
| **Docs** | [/docs](https://x402-relay.aibtc.com/docs) | [/docs](https://x402-relay.aibtc.dev/docs) |
34+
35+
### Facilitator
36+
37+
| Endpoint | URL |
38+
|----------|-----|
39+
| **Health** | [facilitator.stacksx402.com/health](https://facilitator.stacksx402.com/health) |
40+
41+
## Ecosystem Endpoints
42+
43+
| Service | Base URL | Additional |
44+
|---------|----------|------------|
45+
| **STX402** | [stx402.com](https://stx402.com) | [/docs](https://stx402.com/docs), [/dashboard](https://stx402.com/dashboard) |
46+
| **x402 Biwas** | [x402.biwas.xyz](https://x402.biwas.xyz) | [/analytics](https://x402.biwas.xyz/analytics) |
47+
| **StacksScan** | [scan.stacksx402.com](https://scan.stacksx402.com) | — |
48+
49+
## Blockchain APIs
50+
51+
### Hiro API
52+
53+
| Environment | Base URL |
54+
|-------------|----------|
55+
| **Mainnet** | `https://api.hiro.so` |
56+
| **Testnet** | `https://api.testnet.hiro.so` |
57+
58+
**Key endpoints:**
59+
- `GET /extended/v1/tx/{txid}` — Transaction details
60+
- `POST /v2/transactions` — Broadcast transactions
61+
- `GET /extended/v1/address/{principal}/balances` — Token balances
62+
63+
Free API keys at [platform.hiro.so](https://platform.hiro.so). Full docs at [docs.hiro.so](https://docs.hiro.so).
64+
65+
### Block Explorers
66+
67+
| Explorer | Mainnet | Testnet |
68+
|----------|---------|---------|
69+
| **Hiro** | [explorer.hiro.so](https://explorer.hiro.so) | [explorer.hiro.so/?chain=testnet](https://explorer.hiro.so/?chain=testnet) |
70+
71+
## Faucets (Testnet)
72+
73+
- **STX** — [explorer.hiro.so/sandbox/faucet](https://explorer.hiro.so/sandbox/faucet?chain=testnet)
74+
- **sBTC** — [bridge.sbtc.tech](https://bridge.sbtc.tech) (testnet mode)

0 commit comments

Comments
 (0)