docs: add Which TypeScript package do I need? section - #2
Open
mohadon0 wants to merge 1 commit into
Open
Conversation
Add a prominent package-selection guide to docs/integration-guide.md explaining the read/write split between @trustlink/sdk and @trustlink/contract, when to use each, and why two packages exist. Add a note and link to the guide from both package READMEs so that a new integrator landing on either README is immediately directed to the right choice without having to inspect source code.
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
Fills an immediate documentation gap: new integrators reading
docs/integration-guide.mdhad no guidance on which of the two TypeScript packages (@trustlink/sdkvs@trustlink/contract) to reach for, or why two packages exist at all.Changes
docs/integration-guide.mdAdds a prominent "Which TypeScript package do I need?" section near the top of the guide (before the first numbered section). The section includes:
@trustlink/sdk(recommended for most integrators) with a quick-start snippet@trustlink/contract(raw auto-generated bindings) with its specific use cases@trustlink/sdkis recommended for all new integrationsbindings/typescript/README.mdAdds a callout box at the top pointing to the new guide section and directing most developers to
@trustlink/sdk.sdk/typescript/README.mdAdds a callout box at the top pointing to the new guide section for readers who want to understand the full picture.
Acceptance criteria
docs/integration-guide.mdcan pick the correct package on the first read without inspecting source code