Skip to content

Comments

DEV-0: Add SDK documentation section#184

Open
OGrahamPaxos wants to merge 2 commits intomainfrom
sdk-docs-section
Open

DEV-0: Add SDK documentation section#184
OGrahamPaxos wants to merge 2 commits intomainfrom
sdk-docs-section

Conversation

@OGrahamPaxos
Copy link
Collaborator

Summary

  • Add a new SDKs tab to the documentation site with 23 new MDX pages
  • Cover all 4 SDK languages: Go, Python, TypeScript, and Java
  • Include quickstarts, guides (auth, errors, pagination, webhooks, sandbox, AI/agents, migration), and per-service API references for 11 services
  • Update docs.json navigation to include the new SDK section

Pages added

Overview: sdks/index.mdx - Landing page with language cards, feature comparison table, API coverage, and GitHub repository links

Quickstarts (4 pages): Per-language getting started guides with installation, credential setup, and first API call

Guides (7 pages):

  • Authentication - OAuth2 flow, token lifecycle, credential management
  • Error Handling - RFC 7807, typed errors, common errors table, request ID extraction
  • Pagination - Auto-pagination iterators and manual cursor control
  • Events and Webhooks - Reduced-payload pattern, endpoint security, polling alternative
  • Sandbox - Simulating deposits, setting identity status, test workflows
  • AI and Agent Usage - CLAUDE.md/AGENTS.md integration, LLM-friendly documentation
  • Migration - Before/after comparisons, migration checklist

Service References (11 pages): Per-service method references with code examples in all 4 languages (Transfers, Identity, Orders, Profiles, Fiat Transfers, Deposit Addresses, Stablecoin Conversion, Settlement, Market Data, Events, API Credentials)

Notes

  • SDK package names are placeholders - update once SDK repos are published
  • Code examples follow the patterns defined in the SDK Spec
  • All code examples use CodeGroup for language switching with consistent tab order: Go, Python, TypeScript, Java
  • The site already auto-generates llms.txt and llms-full.txt via Mintlify

Test plan

  • Verify Mintlify preview builds successfully with the new pages
  • Check all internal links resolve correctly
  • Verify components render properly
  • Verify the SDKs tab appears in the navigation
  • Review code examples for accuracy against the SDK Spec

Add a complete SDK documentation section with overview, quickstarts for
all 4 languages (Go, Python, TypeScript, Java), guides for authentication,
error handling, pagination, webhooks, sandbox, AI/agent usage, and migration,
plus per-service reference pages for 11 API services. Update docs.json
navigation to include the new SDKs tab.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use absolute URLs for llms.txt and llms-full.txt since these are
dynamically generated files that don't exist as static files in the repo.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to 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.

1 participant