@mysten/docs 0.1.18 → 0.1.20

package/dist/kiosk/kiosk-client/transfer-policy-transaction/introduction.md

@@ -1,6 +1,6 @@
 # TransferPolicyTransaction
 
-> Create and manage transfer policies for kiosk items
+> Create and manage transfer policies for kiosk items using the Kiosk SDK.
 
 `TransferPolicyTransaction` is the client to build transactions that involve transfer policy
 management. It's used similar to `KioskTransaction`, and helps in crafting transactions to manage a

package/dist/kiosk/kiosk-client/transfer-policy-transaction/using-the-manager.md

@@ -1,8 +1,6 @@
 # Using the manager
 
-> Use the TransferPolicyTransaction manager for policy rules
-
-# How to use
+> Use the TransferPolicyTransaction manager to add rules and withdraw profits.
 
 After following the introduction steps on how to initialize a transfer policy transaction you can
 call any of the available functions to prepare your Programmable Transaction Block (PTB).

package/dist/kiosk/llms-index.md

@@ -1,8 +1,8 @@
 # Kiosk
 > Interact with on-chain commerce applications
 
-- [Kiosk SDK](..md): TypeScript SDK for interacting with Sui Kiosk on-chain commerce
-- [Kiosk Client](./kiosk-client/introduction.md): Introduction to the KioskClient for querying and managing kiosks
-- [Querying](./kiosk-client/querying.md): Query kiosk contents, items, and transfer policies
-- [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and examples
-- [Migrating from Kiosk SDK V1](./from-v1.md): Migrate from Kiosk SDK v1 to the current version
+- [Kiosk SDK](..md): TypeScript SDK for interacting with Sui Kiosk onchain commerce.
+- [Kiosk Client](./kiosk-client/introduction.md): Introduction to the KioskClient extension for querying and managing kiosks on Sui.
+- [Querying](./kiosk-client/querying.md): Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
+- [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios.
+- [Migrating from Kiosk SDK V1](./from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API.

package/dist/llms-index.md

@@ -4,124 +4,124 @@
 ## BCS
 > Encoding and decoding Sui objects
 
-- [BCS - Binary Canonical Serialization](./bcs.md): Encode and decode Sui Move types with Binary Canonical Serialization
+- [BCS - Binary Canonical Serialization](./bcs.md): Encode and decode Sui Move types with Binary Canonical Serialization.
 
 ## TypeScript Codegen
 > Generate type-safe TypeScript code from Sui Move packages
 
-- [Sui TypeScript Codegen](./codegen.md): Generate type-safe TypeScript bindings from on-chain Sui Move packages
+- [Sui TypeScript Codegen](./codegen.md): Generate type-safe TypeScript bindings from onchain Sui Move packages.
 
 ## dApp Kit
 > Build Sui dApps with @mysten/dapp-kit-core and @mysten/dapp-kit-react
 
-- [Sui dApp Kit](./dapp-kit.md): Build Sui dApps with framework-agnostic core and React bindings
-- [@mysten/create-dapp](./dapp-kit/getting-started/create-dapp.md): Create a Sui dApp with one command
-- [React](./dapp-kit/getting-started/react.md): Set up dApp Kit in a React application
-- [Next.js](./dapp-kit/getting-started/next-js.md): Set up dApp Kit in a Next.js application
-- [Vue](./dapp-kit/getting-started/vue.md): Set up dApp Kit in a Vue application
+- [Sui dApp Kit](./dapp-kit.md): Build Sui apps with framework-agnostic core and React bindings.
+- [@mysten/create-dapp](./dapp-kit/getting-started/create-dapp.md): Create a Sui app with one command using the create-dapp CLI scaffolding tool.
+- [React](./dapp-kit/getting-started/react.md): Set up dApp Kit in a React application.
+- [Next.js](./dapp-kit/getting-started/next-js.md): Set up dApp Kit in a Next.js application.
+- [Vue](./dapp-kit/getting-started/vue.md): Set up dApp Kit in a Vue application.
 - [DApp Kit Instance](./dapp-kit/dapp-kit-instance.md): Create and configure a DAppKit instance for wallet and client management
-- [State](./dapp-kit/state.md): Access and subscribe to wallet connection state in dApp Kit
-- [Connect Wallet](./dapp-kit/actions/connect-wallet.md): Programmatically connect to a Sui wallet
-- [Disconnect Wallet](./dapp-kit/actions/disconnect-wallet.md): Programmatically disconnect from a Sui wallet
-- [Sign and Execute Transaction](./dapp-kit/actions/sign-and-execute-transaction.md): Sign and execute a transaction using the connected wallet
-- [Sign Personal Message](./dapp-kit/actions/sign-personal-message.md): Sign an arbitrary message with the connected wallet
-- [Sign Transaction](./dapp-kit/actions/sign-transaction.md): Sign a transaction without executing it
-- [Switch Account](./dapp-kit/actions/switch-account.md): Switch the active account in the connected wallet
-- [Switch Network](./dapp-kit/actions/switch-network.md): Switch the active network for the dApp Kit instance
-- [DAppKitProvider](./dapp-kit/react/dapp-kit-provider.md): React context provider for dApp Kit configuration
-- [React Hooks](./dapp-kit/react/hooks.md): React hooks for accessing dApp Kit state and actions
-- [useDAppKit](./dapp-kit/react/hooks/use-dapp-kit.md): React hook to access the full dApp Kit instance
-- [React Components](./dapp-kit/react/components.md): Pre-built React UI components for wallet interaction
-- [Connect Button](./dapp-kit/react/components/connect-button.md): React button component for wallet connection
-- [Connect Modal](./dapp-kit/react/components/connect-modal.md): React modal component for wallet selection
-- [Connect Button](./dapp-kit/web-components/connect-button.md): Framework-agnostic web component for wallet connection
-- [Connect Modal](./dapp-kit/web-components/connect-modal.md): Framework-agnostic web component for wallet selection
-- [Theming](./dapp-kit/theming.md): Customize the appearance of dApp Kit UI components
-- [Sui dApp Kit (Legacy)](./dapp-kit/legacy.md): dApp Kit API reference for @mysten/dapp-kit
+- [State](./dapp-kit/state.md): Access and subscribe to wallet connection state in dApp Kit.
+- [Connect Wallet](./dapp-kit/actions/connect-wallet.md): Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
+- [Disconnect Wallet](./dapp-kit/actions/disconnect-wallet.md): Programmatically disconnect from a Sui wallet using the dApp Kit disconnectWallet action.
+- [Sign and Execute Transaction](./dapp-kit/actions/sign-and-execute-transaction.md): Sign and execute a transaction on the Sui network using the connected wallet.
+- [Sign Personal Message](./dapp-kit/actions/sign-personal-message.md): Sign an arbitrary message with the connected wallet for authentication or proof of ownership.
+- [Sign Transaction](./dapp-kit/actions/sign-transaction.md): Sign a Sui transaction without executing it for deferred or multi-signature scenarios.
+- [Switch Account](./dapp-kit/actions/switch-account.md): Switch the active account in the connected wallet using the dApp Kit switchAccount action.
+- [Switch Network](./dapp-kit/actions/switch-network.md): Switch the active network for the dApp Kit instance between mainnet, testnet, and other networks.
+- [DAppKitProvider](./dapp-kit/react/dapp-kit-provider.md): React context provider that makes dApp Kit available throughout your application.
+- [React Hooks](./dapp-kit/react/hooks.md): React hooks for accessing dApp Kit state and actions in Sui applications.
+- [useDAppKit](./dapp-kit/react/hooks/use-dapp-kit.md): React hook to access the full dApp Kit instance for calling actions directly.
+- [React Components](./dapp-kit/react/components.md): Pre-built React UI components for wallet interaction in Sui dApps.
+- [Connect Button](./dapp-kit/react/components/connect-button.md): React button component for connecting and disconnecting Sui wallets.
+- [Connect Modal](./dapp-kit/react/components/connect-modal.md): React modal component for selecting and connecting to a Sui wallet.
+- [Connect Button](./dapp-kit/web-components/connect-button.md): Framework-agnostic web component providing a complete wallet connection UI for Sui dApps.
+- [Connect Modal](./dapp-kit/web-components/connect-modal.md): Framework-agnostic web component for wallet selection and connection in Sui dApps.
+- [Theming](./dapp-kit/theming.md): Customize the appearance of dApp Kit UI components.
+- [Sui dApp Kit (Legacy)](./dapp-kit/legacy.md): Legacy dApp Kit API reference for the deprecated @mysten/dapp-kit package using JSON RPC.
 
 ## Kiosk
 > Interact with on-chain commerce applications
 
-- [Kiosk SDK](./kiosk.md): TypeScript SDK for interacting with Sui Kiosk on-chain commerce
-- [Kiosk Client](./kiosk/kiosk-client/introduction.md): Introduction to the KioskClient for querying and managing kiosks
-- [Querying](./kiosk/kiosk-client/querying.md): Query kiosk contents, items, and transfer policies
-- [Advanced Examples](./kiosk/advanced-examples.md): Advanced Kiosk SDK usage patterns and examples
-- [Migrating from Kiosk SDK V1](./kiosk/from-v1.md): Migrate from Kiosk SDK v1 to the current version
+- [Kiosk SDK](./kiosk.md): TypeScript SDK for interacting with Sui Kiosk onchain commerce.
+- [Kiosk Client](./kiosk/kiosk-client/introduction.md): Introduction to the KioskClient extension for querying and managing kiosks on Sui.
+- [Querying](./kiosk/kiosk-client/querying.md): Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
+- [Advanced Examples](./kiosk/advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios.
+- [Migrating from Kiosk SDK V1](./kiosk/from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API.
 
 ## Payment Kit
 > Accept payments in any coin type on Sui
 
-- [Payment Kit](./payment-kit.md): Accept payments in any coin type on Sui
-- [Getting Started](./payment-kit/getting-started.md): Install and set up Payment Kit for your Sui dApp
-- [Payment Kit SDK](./payment-kit/payment-kit-sdk.md): Payment Kit SDK API reference and configuration
-- [Payment Processing](./payment-kit/payment-processing.md): Process payments and handle transaction results
-- [Registry Management](./payment-kit/registry-management.md): Manage payment registries and accepted coin types
+- [Payment Kit](./payment-kit.md): Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
+- [Getting Started](./payment-kit/getting-started.md): Install and set up Payment Kit for your Sui application.
+- [Payment Kit SDK](./payment-kit/payment-kit-sdk.md): Payment Kit SDK API reference and configuration for the PaymentKitClient.
+- [Payment Processing](./payment-kit/payment-processing.md): Process registry-based and ephemeral payments and handle transaction results on Sui.
+- [Registry Management](./payment-kit/registry-management.md): Create, configure, and manage payment registries and accepted coin types on Sui.
 
 ## Seal
 > Use Seal, a decentralized secrets management service that secures your data using threshold encryption and on-chain access control.
 
-- [Seal SDK](./seal.md): Decentralized secrets management with threshold encryption on Sui
+- [Seal SDK](./seal.md): Decentralized secrets management with threshold encryption on Sui.
 
 ## Slush Wallet
 > Slush Wallet Integration
 
-- [Slush Wallet Integration](./slush-wallet.md): Integrate Slush Wallet into your Sui dApp
-- [dApp Integration](./slush-wallet/dapp.md): Connect your dApp to Slush Wallet
-- [Deep Linking](./slush-wallet/deep-linking.md): Deep linking configuration for Slush Wallet
+- [Slush Wallet Integration](./slush-wallet.md): Integrate Slush Wallet into your Sui application for mobile and web wallet support.
+- [App Integration](./slush-wallet/dapp.md): Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
+- [Deep Linking](./slush-wallet/deep-linking.md): Configure deep links to open Slush Wallet directly to specific screens or actions.
 
 ## Sui SDK
 > TypeScript interfaces for Sui
 
-- [Sui TypeScript SDK Quick Start](./sui.md): TypeScript SDK for building on the Sui blockchain
-- [Install Sui TypeScript SDK](./sui/install.md): Install the @mysten/sui package and configure your project
-- [LLM Documentation](./sui/llm-docs.md): Give AI agents access to Sui SDK documentation in your project
-- [Hello Sui](./sui/hello-sui.md): Build your first Sui application with the TypeScript SDK
-- [Faucet](./sui/faucet.md): Request test SUI tokens from the faucet
-- [Sui Clients](./sui/clients.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients
-- [Core API](./sui/clients/core.md): Transport-agnostic Core API shared by all Sui clients
-- [SuiGrpcClient](./sui/clients/grpc.md): Connect to Sui via gRPC with SuiGrpcClient
-- [SuiGraphQLClient](./sui/clients/graphql.md): Connect to Sui via GraphQL with SuiGraphQLClient
-- [SuiJsonRpcClient](./sui/clients/json-rpc.md): Connect to Sui via JSON-RPC with SuiJsonRpcClient
-- [Sui Programmable Transaction Basics](./sui/transaction-building/basics.md): Construct programmable transaction blocks with the Transaction API
-- [Paying for Sui Transactions with Gas Coins](./sui/transaction-building/gas.md): Configure gas budget, price, and coin selection for transactions
-- [Transaction Intents](./sui/transaction-building/intents.md): Use high-level intents to simplify transaction building
-- [Building Offline](./sui/transaction-building/offline.md): Build transactions without a network connection
-- [Sponsored Transactions](./sui/transaction-building/sponsored-transactions.md): Pay gas fees on behalf of other users with sponsored transactions
-- [Key pairs](./sui/cryptography/keypairs.md): Create and manage Ed25519, Secp256k1, and Secp256r1 keypairs
-- [Multi-Signature Transactions](./sui/cryptography/multisig.md): Create multi-signature transactions with multiple signers
-- [Passkey](./sui/cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing
-- [Web Crypto Signer](./sui/cryptography/webcrypto-signer.md): Sign transactions using the Web Crypto API
-- [The `@mysten/sui/utils` package](./sui/utils.md): Utility functions for addresses, coins, and common operations
-- [Derived Objects](./sui/utils/derived_objects.md): Compute derived object IDs from parent objects
-- [BCS](./sui/bcs.md): Binary Canonical Serialization for encoding Sui Move types
-- [ZkLogin](./sui/zklogin.md): Zero-knowledge authentication with OAuth providers on Sui
-- [Transaction Executors](./sui/executors.md): Manage transaction execution with queuing and parallel strategies
-- [Transaction Plugins](./sui/plugins.md): Extend transaction building with reusable plugins
-- [Building SDKs](./sui/sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
-- [Migrate to 2.0](./sui/migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0
-- [Agent Migration Prompt](./sui/migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration
-- [@mysten/sui](./sui/migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0
-- [Migrating from JSON-RPC](./sui/migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to the new Core API
-- [@mysten/dapp-kit](./sui/migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to 2.0
-- [@mysten/kiosk](./sui/migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0
-- [@mysten/zksend](./sui/migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0
-- [@mysten/suins](./sui/migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0
-- [@mysten/deepbook-v3](./sui/migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0
-- [@mysten/walrus](./sui/migrations/sui-2.0/walrus.md): Migrate @mysten/walrus to 2.0
-- [@mysten/seal](./sui/migrations/sui-2.0/seal.md): Migrate @mysten/seal to 2.0
-- [Wallet Builders](./sui/migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension developers
-- [SDK Maintainers](./sui/migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors
-- [Migrate to 1.0](./sui/migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0
-- [Migrate to 0.38.0](./sui/migrations/0.38.md): Migrate from SDK version 0.37 to 0.38
+- [Sui TypeScript SDK Quick Start](./sui.md): The Sui TypeScript SDK is a modular library of tools for interacting with the Sui blockchain.
+- [Install Sui TypeScript SDK](./sui/install.md): Install the @mysten/sui package and configure your project.
+- [LLM Documentation](./sui/llm-docs.md): Give AI agents access to Sui SDK documentation in your project.
+- [Hello Sui](./sui/hello-sui.md): Build your first Sui application with the TypeScript SDK.
+- [Faucet](./sui/faucet.md): Request test SUI tokens from the faucet on Devnet, Testnet, or local networks.
+- [Sui Clients](./sui/clients.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients for the Sui network.
+- [Core API](./sui/clients/core.md): Transport-agnostic Core API shared by all Sui clients.
+- [SuiGrpcClient](./sui/clients/grpc.md): Connect to Sui through gRPC with SuiGrpcClient.
+- [SuiGraphQLClient](./sui/clients/graphql.md): Connect to Sui through GraphQL with SuiGraphQLClient.
+- [SuiJsonRpcClient](./sui/clients/json-rpc.md): Connect to Sui through JSON-RPC with SuiJsonRpcClient.
+- [Sui Programmable Transaction Basics](./sui/transaction-building/basics.md): Construct programmable transaction blocks with the Transaction API.
+- [Paying for Sui Transactions with Gas Coins](./sui/transaction-building/gas.md): Configure gas budget, price, and coin selection for Sui transactions.
+- [Transaction Intents](./sui/transaction-building/intents.md): Use high-level intents to simplify transaction building.
+- [Building Offline](./sui/transaction-building/offline.md): Build transactions without a network connection.
+- [Sponsored Transactions](./sui/transaction-building/sponsored-transactions.md): Pay gas fees on behalf of other users with sponsored transactions.
+- [Key pairs](./sui/cryptography/keypairs.md): Create and manage Ed25519, Secp256k1, and Secp256r1 keypairs for Sui transaction signing.
+- [Multi-Signature Transactions](./sui/cryptography/multisig.md): Create multi-signature transactions with multiple signers on Sui.
+- [Passkey](./sui/cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing.
+- [Web Crypto Signer](./sui/cryptography/webcrypto-signer.md): Sign transactions using the Web Crypto API for secure browser-based key management.
+- [The `@mysten/sui/utils` package](./sui/utils.md): Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
+- [Derived Objects](./sui/utils/derived_objects.md): Compute derived object IDs from parent objects for deterministic offline derivation.
+- [BCS](./sui/bcs.md): Binary Canonical Serialization for encoding Sui Move types.
+- [ZkLogin](./sui/zklogin.md): Zero-knowledge authentication with OAuth providers on Sui.
+- [Transaction Executors](./sui/executors.md): Manage transaction execution with queuing and parallel strategies.
+- [Transaction Plugins](./sui/plugins.md): Extend transaction building with reusable plugins.
+- [Building SDKs](./sui/sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK.
+- [Migrate to 2.0](./sui/migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0 covering all @mysten packages.
+- [Agent Migration Prompt](./sui/migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration of your codebase.
+- [@mysten/sui](./sui/migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0 with new client APIs and BCS changes.
+- [Migrating from JSON-RPC](./sui/migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to the new Core API using SuiGrpcClient or SuiGraphQLClient.
+- [@mysten/dapp-kit](./sui/migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to the new dapp-kit-react package in 2.0.
+- [@mysten/kiosk](./sui/migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction.
+- [@mysten/zksend](./sui/migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API.
+- [@mysten/suins](./sui/migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0 with client extension pattern.
+- [@mysten/deepbook-v3](./sui/migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0 with client extension pattern.
+- [@mysten/walrus](./sui/migrations/sui-2.0/walrus.md): Migrate @mysten/walrus to 2.0 with required client parameter and updated API.
+- [@mysten/seal](./sui/migrations/sui-2.0/seal.md): Migrate @mysten/seal to 2.0 with the new registration function pattern.
+- [Wallet Builders](./sui/migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension developers upgrading to 2.0.
+- [SDK Maintainers](./sui/migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors upgrading to 2.0.
+- [Migrate to 1.0](./sui/migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0 with new features and API changes.
+- [Migrate to 0.38.0](./sui/migrations/0.38.md): Migrate from SDK version 0.37 to 0.38 with updated module structure and API changes.
 
 ## Walrus
 > Publish and Read blobs directly from walrus storage nodes
 
-- [Walrus SDK](./walrus.md): Store and retrieve blobs on Walrus decentralized storage
+- [Walrus SDK](./walrus.md): Store and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
 
 ## ZkSend
 > Send Sui with a link
 
-- [zkSend SDK](./zksend.md): Send Sui assets via shareable links with zkSend
-- [Creating zkSend Links](./zksend/link-builder.md): Create and customize zkSend claim links
+- [zkSend SDK](./zksend.md): Send Sui assets through shareable claim links using the zkSend SDK.
+- [Creating zkSend Links](./zksend/link-builder.md): Create and customize zkSend claim links for sending Sui assets.
 - [Composable Claims](./zksend/composable-claim.md): Claim a zkSend link and use the assets in the same transaction

package/dist/payment-kit/getting-started.md

@@ -1,6 +1,6 @@
 # Getting Started
 
-> Install and set up Payment Kit for your Sui dApp
+> Install and set up Payment Kit for your Sui application.
 
 > **Note:** This package is in active development and should be used with caution. APIs are experimental and
 > subject to breaking changes without notice. We recommend thoroughly testing any implementation
@@ -12,7 +12,7 @@ This guide will help you set up and start using the Payment Kit SDK in your Sui
 
 Before you begin, ensure you have:
 
-- A Sui wallet with testnet/mainnet SUI tokens
+- A Sui wallet with Testnet or Mainnet SUI tokens
 - Basic understanding of TypeScript and the Sui blockchain
 
 ## Installation
@@ -23,7 +23,7 @@ Install the Payment Kit SDK and the Sui TypeScript SDK:
 npm install --save @mysten/payment-kit @mysten/sui
 ```
 
-## Setting Up the Client
+## Setting up the client
 
 The Payment Kit SDK extends the standard `SuiGrpcClient` to provide payment functionality. Here's
 how to set it up:
@@ -38,11 +38,11 @@ const client = new SuiGrpcClient({
 ```
 
 The client will automatically configure the correct package IDs for the network you're using
-(testnet or mainnet).
+(Testnet or Mainnet).
 
-## Your First Payment
+## Your first payment
 
-Let's process a simple registry-based payment using the default payment registry:
+Let's process a basic registry-based payment using the default payment registry:
 
 ```ts
 
@@ -77,7 +77,7 @@ if (result.$kind === 'FailedTransaction') {
 console.log('Payment processed:', result.Transaction.digest);
 ```
 
-## Understanding the Payment
+## Understanding the payment
 
 In this example:
 
@@ -88,7 +88,7 @@ In this example:
 5. **Sender**: The address sending the payment (must match the transaction signer)
 6. **Registry Name**: The payment registry to use (defaults to `DEFAULT_REGISTRY_NAME`)
 
-## Verifying the Payment
+## Verifying the payment
 
 After processing a payment, you can query the payment record to verify it exists:
 
@@ -110,7 +110,7 @@ if (paymentRecord) {
 }
 ```
 
-## Processing an Ephemeral Payment
+## Processing an ephemeral payment
 
 If you don't need duplicate prevention or persistent storage, use ephemeral payments:
 
@@ -143,7 +143,7 @@ Ephemeral payments:
 - Still emit a `PaymentReceipt` event
 - Have lower gas costs
 
-## Working with Different Coin Types
+## Working with different coin types
 
 Payment Kit supports any Sui coin type. Here's how to process payments with custom coins:
 
@@ -166,7 +166,7 @@ const result = await client.signAndExecuteTransaction({
 });
 ```
 
-## Error Handling
+## Error handling
 
 Always wrap payment operations in try-catch blocks:
 
@@ -194,7 +194,7 @@ try {
 }
 ```
 
-## Creating Payment URIs
+## Creating payment URIs
 
 Payment Kit provides helper functions to create and parse Payment Kit transaction URIs. These URIs
 are useful for generating payment links, QR codes, or deep links in your application:
@@ -247,7 +247,7 @@ const tx = client.paymentKit.tx.processRegistryPayment({
 });
 ```
 
-## Next Steps
+## Next steps
 
 Now that you understand the basics, explore more advanced features:
 

package/dist/payment-kit/index.md

@@ -1,13 +1,13 @@
 # Payment Kit
 
-> Accept payments in any coin type on Sui
+> Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
 
 > **Note:** This package is in active development and should be used with caution. APIs are experimental and
 > subject to breaking changes without notice. We recommend thoroughly testing any implementation
 > before using in production environments.
 
-The Sui Payment Kit SDK is a TypeScript library that provides a simple and secure way to process
-blockchain payments on the Sui network. It offers flexible payment processing with built-in
+The Sui Payment Kit SDK is a TypeScript library that provides a straightforward and secure way to
+process blockchain payments on the Sui network. It offers flexible payment processing with built-in
 duplicate prevention, configurable payment registries, and comprehensive receipt management.
 
 ## Overview
@@ -19,10 +19,10 @@ with minimal setup. The SDK provides two payment models:
   expiration
 - **Ephemeral payments**: Lightweight payment processing without persistent storage
 
-All payments emit a `PaymentReceipt` that can be stored off-chain for verification and
+All payments emit a `PaymentReceipt` that can be stored offchain for verification and
 record-keeping.
 
-## Key Features
+## Key features
 
 - **Duplicate Prevention**: Registry-based payments automatically prevent duplicate transactions
 - **Flexible Payment Models**: Choose between registry-based or ephemeral payment processing
@@ -38,7 +38,7 @@ record-keeping.
 npm install --save @mysten/payment-kit @mysten/sui
 ```
 
-## Quick Start
+## Quick start
 
 ```ts
 
@@ -69,7 +69,7 @@ if (result.$kind === 'FailedTransaction') {
 }
 ```
 
-## Network Support
+## Network support
 
 Payment Kit supports the following Sui networks:
 
@@ -79,9 +79,9 @@ Payment Kit supports the following Sui networks:
 The SDK automatically configures the correct package and object IDs based on the network specified
 in your `SuiGrpcClient` configuration.
 
-## Core Concepts
+## Core concepts
 
-### Payment Processing
+### Payment processing
 
 Payment Kit offers two distinct payment processing models to suit different application needs:
 
@@ -90,7 +90,7 @@ Payment Kit offers two distinct payment processing models to suit different appl
 2. **Ephemeral Payments**: Processes payments without persistent storage, suitable for scenarios
    where duplicate prevention is handled externally
 
-### Payment Registries
+### Payment registries
 
 A `PaymentRegistry` manages payment records and configurations. Benefits include:
 
@@ -99,7 +99,7 @@ A `PaymentRegistry` manages payment records and configurations. Benefits include
 - Optional fund management
 - Custom naming for easy identification and indexing
 
-### Payment Records
+### Payment records
 
 When using registry-based payments, a `PaymentRecord` is created as a Dynamic Field on the registry.
 Records are identified by a composite key derived from:
@@ -109,7 +109,7 @@ Records are identified by a composite key derived from:
 - Coin type
 - Receiver address
 
-### Payment Receipts
+### Payment receipts
 
 Every payment (registry-based or ephemeral) emits a `PaymentReceipt` event containing:
 
@@ -124,7 +124,7 @@ type PaymentReceipt = {
 };
 ```
 
-## Next Steps
+## Next steps
 
 - [Getting Started Guide](/payment-kit/getting-started) - Detailed setup and usage instructions
 - [Payment Processing](/payment-kit/payment-processing) - Learn about different payment models

package/dist/payment-kit/llms-index.md

@@ -1,8 +1,8 @@
 # Payment Kit
 > Accept payments in any coin type on Sui
 
-- [Payment Kit](..md): Accept payments in any coin type on Sui
-- [Getting Started](./getting-started.md): Install and set up Payment Kit for your Sui dApp
-- [Payment Kit SDK](./payment-kit-sdk.md): Payment Kit SDK API reference and configuration
-- [Payment Processing](./payment-processing.md): Process payments and handle transaction results
-- [Registry Management](./registry-management.md): Manage payment registries and accepted coin types
+- [Payment Kit](..md): Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
+- [Getting Started](./getting-started.md): Install and set up Payment Kit for your Sui application.
+- [Payment Kit SDK](./payment-kit-sdk.md): Payment Kit SDK API reference and configuration for the PaymentKitClient.
+- [Payment Processing](./payment-processing.md): Process registry-based and ephemeral payments and handle transaction results on Sui.
+- [Registry Management](./registry-management.md): Create, configure, and manage payment registries and accepted coin types on Sui.

package/dist/payment-kit/payment-kit-sdk.md

@@ -1,6 +1,6 @@
 # Payment Kit SDK
 
-> Payment Kit SDK API reference and configuration
+> Payment Kit SDK API reference and configuration for the PaymentKitClient.
 
 > **Note:** This package is in active development and should be used with caution. APIs are experimental and
 > subject to breaking changes without notice. We recommend thoroughly testing any implementation
@@ -8,7 +8,7 @@
 
 Complete API reference for the Payment Kit SDK.
 
-## Client Setup
+## Client setup
 
 ### PaymentKitClient
 
@@ -46,7 +46,7 @@ client.paymentKit.tx.processRegistryPayment(/* ... */);
 
 - `PaymentKitClientError` if network is unsupported
 
-## Transaction Methods
+## Transaction methods
 
 Transaction methods create complete, ready-to-sign transactions.
 
@@ -74,7 +74,7 @@ type ProcessRegistryPaymentOptions = {
 
 **Returns:** `Transaction` - Ready-to-sign transaction
 
-**Note:** If you rather provide the `registryId` you can do so instead of the `registryName`.
+If you prefer to provide the `registryId`, you can do so instead of the `registryName`.
 
 **Example:**
 
@@ -404,7 +404,7 @@ const result = await client.signAndExecuteTransaction({
 - Removes the payment record from the registry
 - Sender receives storage rebate
 
-## Query Methods
+## Query methods
 
 ### `client.paymentKit.getPaymentRecord()`
 
@@ -462,7 +462,7 @@ if (record) {
 - Check for duplicate payments before processing
 - Retrieve payment details for reconciliation
 
-## Call Methods
+## Call methods
 
 Call methods return transaction commands that can be composed in custom transactions. Use these when
 you need fine-grained control over transaction construction.
@@ -516,7 +516,7 @@ await client.signAndExecuteTransaction({
 });
 ```
 
-### Other Call Methods
+### Other call methods
 
 All transaction methods have corresponding call methods:
 
@@ -529,7 +529,7 @@ All transaction methods have corresponding call methods:
 
 ## Types
 
-### PaymentReceipt Event
+### PaymentReceipt event
 
 Emitted when a payment is processed (registry or ephemeral).
 
@@ -567,7 +567,7 @@ if (receiptEvent) {
 }
 ```
 
-## Error Handling
+## Error handling
 
 ### PaymentKitClientError
 
@@ -579,13 +579,13 @@ class PaymentKitClientError extends Error {
 }
 ```
 
-## URI Utilities
+## URI utilities
 
 Payment Kit provides utility functions for creating and parsing payment transaction URIs. These URIs
 follow the `sui:pay` protocol and can be used to encode payment parameters for QR codes, deep links,
 or other sharing mechanisms.
 
-### URI Format
+### URI format
 
 Payment URIs follow the `sui:pay` protocol:
 
@@ -603,12 +603,12 @@ sui:pay?
 
 **Required Parameters:**
 
-| Parameter  | Description                                  |
-| ---------- | -------------------------------------------- |
-| `receiver` | Recipient Sui address                        |
-| `amount`   | Payment amount in smallest unit (e.g., MIST) |
-| `coinType` | Coin type (e.g., `0x2::sui::SUI`)            |
-| `nonce`    | Unique payment identifier (max 36 chars)     |
+| Parameter  | Description                                         |
+| ---------- | --------------------------------------------------- |
+| `receiver` | Recipient Sui address                               |
+| `amount`   | Payment amount in smallest unit (for example, MIST) |
+| `coinType` | Coin type (for example, `0x2::sui::SUI`)            |
+| `nonce`    | Unique payment identifier (max 36 chars)            |
 
 **Optional Parameters:**
 
@@ -740,7 +740,7 @@ const tx = client.paymentKit.tx.processRegistryPayment({
 - `PaymentKitUriError` if nonce exceeds 36 characters
 - `PaymentKitUriError` if amount is not a positive number
 
-### Future Versions
+### Future versions
 
 Check the
 [CHANGELOG](https://github.com/MystenLabs/ts-sdks/blob/main/packages/payment-kit/CHANGELOG.md) for