Skip to content

docs: introduce Rust Developer SDK setup - #53

Merged
edo-chan merged 1 commit into
mainfrom
wuh/rust-docs-setup
Nov 6, 2026
Merged

edo-chan merged 1 commit into
mainfrom
wuh/rust-docs-setup

Conversation

@thewuhxyz

@thewuhxyz thewuhxyz commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Add native Rust SDK setup guidance alongside TypeScript and Python.

Changes

  • Add Rust to the Developer SDK overview and introduction.
  • Document installation of Rust SDK 0.1.0 from crates.io.
  • Show client construction, API-key configuration, and network selection.
  • Explain the current Rust API shapes and supported integration paths.

Pages updated

  • overview/developer-sdk.mdx
  • developer-sdk/index.mdx
  • developer-sdk/integration-paths.mdx

Validation

  • All 1 Rust snippets present at this branch head compile against SDK 0.1.0 with Rust 1.87 using cargo +1.87.0 check --offline --locked in a temporary harness. Application-owned inputs and callbacks are supplied by the harness.
  • Offline MDX, configuration, and local-link checks pass for this exact branch head.
  • Strict offline Mintlify prebuild passes with OpenAPI generation disabled.
  • git diff --check passes.
  • Existing TypeScript and Python snippets are unchanged.
  • Validation does not execute live hosted calls, transactions, or on-chain flows.

Stack

1 of 6 — Setup and configuration.

Base: main
Next: wuh/rust-docs-wallet-reads (#54)

@edo-chan edo-chan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Rust setup pins a0eea63, but that commit is not an ancestor of the current Rust SDK #60 head (8d5e773). The current tip differs across 122 SDK source files, so the cited snippet compilation does not validate the code this docs stack is meant to describe. Before marking this chain ready, pin the intended final SDK revision and recompile the Rust snippets in #53–#58 against that exact revision. Mintlify validation and link checks pass at the docs tip, but they do not check Rust API compatibility.

@thewuhxyz
thewuhxyz force-pushed the wuh/rust-docs-setup branch from abbb63d to 8943f97 Compare October 31, 2026 07:00
@thewuhxyz
thewuhxyz force-pushed the wuh/rust-docs-setup branch from 8943f97 to c3e8374 Compare November 2, 2026 17:43
@thewuhxyz
thewuhxyz marked this pull request as ready for review November 2, 2026 17:44
@thewuhxyz
thewuhxyz requested a review from edo-chan November 2, 2026 17:59
Comment thread developer-sdk/index.mdx
<Tab title="Rust">

```bash
cargo add swig-developer-sdk@0.1.0

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Publish the crate before documenting this installation command

cargo +1.87.0 info swig-developer-sdk@0.1.0 currently fails with could not find swig-developer-sdk@0.1.0 in registry, so a new Rust user cannot get past the documented installation step. Please publish and verify version 0.1.0 before deploying these docs, or document a working pinned Git installation until the crate is available. The same crates.io instruction in developer-sdk/integration-paths.mdx needs to stay consistent.

@edo-chan
edo-chan merged commit 69d2268 into main Nov 6, 2026
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.

2 participants