Skip to content

Restructure docs as canonical reference layer - #7

Merged
whoabuddy merged 2 commits into
mainfrom
docs/reference-layer
Jan 28, 2026
Merged

Restructure docs as canonical reference layer#7
whoabuddy merged 2 commits into
mainfrom
docs/reference-layer

Conversation

@whoabuddy

Copy link
Copy Markdown
Contributor

Summary

Transforms docs.aibtc.com from tutorial-style content into a canonical reference layer that ties together the AIBTC ecosystem. The landing page (aibtc.com) now handles getting started/tutorials; docs becomes the "phone book" for looking things up.

New Structure

PathPurpose
/Navigation hub with quick reference tables
/directory/Services, tools, SDKs, templates, repositories
/reference/tokens/Contract addresses, CAIP identifiers, decimals, where to get tokens
/reference/networks/Mainnet/testnet configs, API endpoints, service URLs
/glossary/Term definitions (unchanged)

Removed

  • /guides/what-is-x402/ — Landing page interactive tutorial covers this better
  • /guides/services/ — Replaced by comprehensive /directory/
  • /guides/tokens/ — Replaced by /reference/tokens/ with contract addresses

Key Additions

Token Reference:

  • Mainnet/testnet contract addresses for STX, sBTC, USDCx
  • CAIP-19 asset identifiers
  • Token decimals and standards (SIP-010)
  • Where to get tokens (exchanges, bridges, faucets)

Network Reference:

  • CAIP-2 network identifiers
  • All AIBTC service endpoints (x402 API, Sponsor Relay, Facilitator)
  • Ecosystem services (STX402, Biwas, StacksScan)
  • Hiro API endpoints and keys

Directory:

  • Complete service catalog with mainnet/testnet links
  • Tools & SDKs (@aibtc/mcp-server, x402-stacks, Stacks.js)
  • Templates & examples
  • All AIBTC repositories
  • External resources

Closes#2

Test plan

  • Verify all internal links resolve
  • Verify external links are correct
  • Check homepage quick reference tables render properly
  • Build passes (npm run build)

🤖 Generated with Claude Code

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>
@cloudflare-workers-and-pages

cloudflare-workers-and-pagesBot commented Jan 28, 2026

Copy link
Copy Markdown

Deploying aibtc-docs with Cloudflare Pages Cloudflare Pages

Latest commit:653cb20
Status: ✅ Deploy successful!
Preview URL:https://c05702d9.aibtc-docs.pages.dev
Branch Preview URL:https://docs-reference-layer.aibtc-docs.pages.dev

View logs

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>
@whoabuddy
whoabuddy merged commit 32aef73 into mainJan 28, 2026
1 check passed
@whoabuddy
whoabuddy deleted the docs/reference-layer branch January 28, 2026 16:52
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: add more resources / info

1 participant

@whoabuddy