Add an SDK quickstart page (#134)#300
Open
olaleyeolajide81-sketch wants to merge 2 commits into
Open
Conversation
Closes tributary-protocol#134 Add a five-minute SDK quickstart (install, read a split, create one, pay through it) and link it from the README. Include the new doc in the CI markdown-link check.
Contributor
|
This PR's |
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
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
Closes #134. New users needed a short path from install to first call. This adds
docs/quickstart.md, a five-minute walkthrough of the TypeScript SDK, and links it from the README.What the quickstart covers
get_splitcreate_splitwith a minimal inline signerpreview_payoutthenpayAcceptance criteria
docs/quickstart.md)docs/quickstart.mdadded to the markdown-link-check step in.github/workflows/ci.ymlVerification
npm run build(sdk,tsc) — passesmarkdown-link-checkonREADME.md,docs/architecture.md,docs/integrations.md,docs/mainnet.md, anddocs/quickstart.md— passes (no broken links)cargo fmt --all --check,cargo clippy --all-targets -- -D warnings,cargo test) were not run in this environment (no Rust toolchain), but this change is documentation-only; no contract or SDK code behavior changed, sono_std/typed-error rules and Rust tests are unaffected.Test plan
closes #134