feat: replace integration section with SDK reference pages#40
Merged
Conversation
The previous integration pages documented an older codegen-based workflow where users ran `trix bindgen` and called generated per-protocol functions from a `protocol.ts` / `protocol.go` / etc. file. That model no longer matches reality: each of the four official SDK repos (web/Go/Rust/Python) now ships a runtime library that loads a compiled `.tii` protocol, binds parties and signers, and drives the full resolve → sign → submit → wait lifecycle through TRP. Replace the section with one page per SDK, authored from the corresponding repo's README: - typescript.md (tx3-lang/web-sdk) - go.md (tx3-lang/go-sdk) - rust.md (tx3-lang/rust-sdk) - python.md (tx3-lang/python-sdk) Also add an Integration index page introducing the four SDKs, and drop a dead link in tooling/trix.mdx that pointed at the removed integration/codegen page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
trix bindgencodegen workflow) with one runtime-SDK reference page per language, each sourced from the corresponding repo's README:integration/typescript.md— tx3-lang/web-sdkintegration/go.md— tx3-lang/go-sdkintegration/rust.md— tx3-lang/rust-sdkintegration/python.md— tx3-lang/python-sdkintegration/index.mdxas a landing page with LinkCards for all four SDKs.[Bindgen Guide]link intooling/trix.mdxthat pointed at the removedintegration/codegenpage.nodejs.md→typescript.md(the web SDK is published astx3-sdkand runs in Node, browsers, Bun, and Deno — "NodeJS Backend" was misleading).Why
The previous pages described an older codegen-based workflow where users ran
trix bindgenand called generated per-protocol functions. The official SDKs are now runtime libraries that load a compiled.tiiprotocol, bind parties and signers, and drive theresolve → sign → submit → waitlifecycle through TRP. The docs needed to reflect that shift.Each page preserves the README's Installation, Quick start, Concepts table, Advanced usage subsections (low-level TRP, Custom Signer, Manual witness, and any language-specific extras like CIP-30 / Framework integrations / Error handling), and protocol-compatibility info, while trimming repo-only bits (badges, monorepo notes, Testing, License).
Conflict note
Open PR #33 (
feat: enhance Rust integration documentation) also editsintegration/rust.md. This PR completely replaces that file from the rust-sdk README, so #33 will need to be rebased or its incremental edits folded into the new page after this lands.Test plan
/tx3/integration/renders the LinkCard grid/tx3/integration/{typescript,go,rust,python}) renders with proper code highlighting and the concepts table/tx3/tooling/trixno longer contains a broken../integration/codegenlink🤖 Generated with Claude Code