[Sendi0011]

Summary

Closes #279.

Adds the SDK's documentation and examples layer so third parties can integrate without reverse-engineering the contracts or app.

• Runnable examples in sdk/examples/ importing only from the package root:
  • public API surface/utilities
  • read pool state
  • deposit (rotational + flexible)
  • action gating decisions
  • diagnostics/recovery flow
  • HTTP DataClient pagination and errors
• Examples compile in CI against the built dist/ declarations via pnpm typecheck:examples.
• SDK README rewritten: badges, install, quick start, client groups, domain types, utilities, gating, diagnostics/recovery, data client, error model, versioning/deprecation, development.
• docs/sdk.md integration guide: architecture, signer contract, networks/config, error taxonomy, recovery, testing/mocking, security, frontend parity.
• docs/README.md documentation index.
• sdk/CHANGELOG.md with 0.1.0 release notes and semver/deprecation policy.
• Root README adds an SDK section and documentation links; CONTRIBUTING.md documents SDK gates and public-API rules.
• Removed broken pre-existing relative links found while validating docs.

Verification

From sdk/:

pnpm typecheck          pass
pnpm build              pass
pnpm typecheck:examples pass
pnpm test               187/187 tests, 15 files
pnpm check:api          pass (177 symbols)

All relative links in the touched docs resolve. Examples contain no secrets; signer stubs return the unsigned envelope and are clearly marked as replacements.

Notes

Stacked on #288 (feat/sdk-data-client); retarget to develop as the stack merges.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
joint-save	Ready	Preview	Nov 5, 2026 12:49pm UTC
joint-save-y4yx	Ready	Preview	Nov 5, 2026 12:49pm UTC