docs(readme): align README with the web/python/go builder ports#38
Merged
Conversation
The rust-sdk README's quick start already showed the unified-builder shape, but the concepts table, the Cargo.toml install snippet, and the advanced- usage section had drifted from what the other three SDKs now ship after the unified-builder propagation. Aligning so the fleet reads as a single documented surface: - Bumps the example Cargo.toml from "0.11" to "0.12" (current published version is 0.12.0; the snippet was stale). - Adds the "All fallible validation happens in build()" callout under the quick start (matches the web/python/go README copy). - Expands the concepts table with Profile, Tx3ClientBuilder seeding details, and the named builder-error variants of tx3_sdk::Error. - Adds a "Skipping the runtime .tii (codegen flow)" section showing Tx3ClientBuilder::from_parts. - Documents with_header (TRP auth) and with_env_value (one-off env overrides) — both shipped but previously absent from the README. No code changes — README-only. 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
The rust-sdk README's quick start already showed the unified-builder shape, but the rest of the doc had drifted from the version that ships in tx3-lang/web-sdk#29, tx3-lang/python-sdk#13, and tx3-lang/go-sdk#10. This PR aligns the rust README so the fleet reads as a single documented surface.
Result<_, Error>shape).Profile, the seeding details ofTx3ClientBuilder, and the named builder-error variants oftx3_sdk::Error.Tx3ClientBuilder::from_parts(...)directly.with_headerandwith_env_valueare now documented — both shipped but previously absent from the README.No code changes — README-only.
Test plan
🤖 Generated with Claude Code