YNU-864: Native TS SDK pages polish + terminology#153
Open
ihsraham wants to merge 1 commit intodocs/reorg-for-v1from
Open
YNU-864: Native TS SDK pages polish + terminology#153ihsraham wants to merge 1 commit intodocs/reorg-for-v1from
ihsraham wants to merge 1 commit intodocs/reorg-for-v1from
Conversation
- Add a pinned SDK decision table and align Build SDK terminology on Nitronode. - Update native TypeScript setup, config, API, and examples with sandbox placeholders, error recovery, source-verified method shapes, and browser signers that compile against SDK interfaces. - Rewrite multi-party app sessions around native v1 AppDefinitionV1, app registration, signed state updates, withdraw, and close intents. - Clarify migration-guide amount semantics and codemod source workflow. Resolves: F-008 (Build SDK slice), F-009 (typescript page slice), F-013, F-014, F-024, F-025, F-026, F-027, F-028, F-029.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
Polishes the native v1 SDK docs so builders land on the right package, use Nitronode terminology, and see source-verified TypeScript SDK shapes for channel and app-session flows.
Changes
setHomeBlockchain()guidance, and common error recovery patterns.StateSignerandTransactionSignermatch the SDK interfaces.AppDefinitionV1,registerApp()/apps.v1.submit_app_version, packed participant signatures, deposit, operate, withdraw, and close viaAppStateUpdateIntent.Close.@yellow-org/nitrolite-codemodis published.Files to review
docs/nitrolite/build/sdk/index.mddocs/nitrolite/build/sdk/typescript/getting-started.mdxdocs/nitrolite/build/sdk/typescript/configuration.mdxdocs/nitrolite/build/sdk/typescript/api-reference.mdxdocs/nitrolite/build/sdk/typescript/examples.mdxdocs/nitrolite/build/sdk/migration-guide.mddocs/nitrolite/build/sdk/multi-party-app-sessions.mdxdocs/nitrolite/build/sdk/go/getting-started.mdxdocs/nitrolite/build/sdk/go/api-reference.mdxRelated PR
#149 adds the generated v1 API Reference pages. This PR names the backing RPC methods in the TypeScript SDK docs, but keeps them as code references rather than Markdown links so this branch remains build-clean before #149 lands.
Validation
@yellow-org/sdksource interfaces.vale --minAlertLevel=erroron changed docs: 0 findings.npm run build: succeeds; warning set is the pre-existing 0.5.x / Clearnet warning set, with no changed PR5 source page in the broken-link output.go get github.com/layer-3/nitrolite/sdk/go@latestsucceeds in a temporary module.http://127.0.0.1:3000/nitrolite/build/sdk/multi-party-app-sessions.Resolves: F-008 (Build SDK slice), F-009 (typescript page slice), F-013, F-014, F-024, F-025, F-026, F-027, F-028, F-029.