@mysten/docs 0.1.17 → 0.1.19

package/dist/sui/migrations/sui-1.0.md

@@ -1,8 +1,8 @@
 # Migrate to 1.0
 
-> Migrate to Sui TypeScript SDK 1.0
+> Migrate to Sui TypeScript SDK 1.0 with new features and API changes.
 
-We are excited to announce the 1.0 release of the Typescript SDK. This release includes a lot of new
+We are excited to announce the 1.0 release of the TypeScript SDK. This release includes a lot of new
 features, as well as number of renames, and cleanup of old APIs that no longer make sense.
 
 This migration guide will primarily focus on helping migrate existing features that have changed in
@@ -15,7 +15,7 @@ highlights:
 - [A new Plugin system for Extending Transaction Building](../plugins)
 
 The majority of changes in this release are in the `@mysten/sui` package, but the changes to API
-require some breaking changes across all the Typescript SDKs. You can find migration guides for all
+require some breaking changes across all the TypeScript SDKs. You can find migration guides for all
 affected packages below:
 
 ## Changes to `@mysten/sui`
@@ -76,7 +76,7 @@ correspond to specific JSON RPC calls. The following methods are unchanged:
 - `suiClient.dryRunTransactionBlock`
 - `suiClient.devInspectTransactionBlock`
 
-### Building Transactions
+### Building transactions
 
 With the introduction of the Transaction plugin API, and Transaction Intents, serializing
 transactions is now an asynchronous process.
@@ -85,11 +85,11 @@ transactions is now an asynchronous process.
 method will invoke any serialization plugins used by the transaction, and return JSON in a new
 Transaction JSON Format.
 
-We have also removed the protocol config and limits options since enforcing these limits in the
+We have also removed the protocol config and limits options because enforcing these limits in the
 Transaction builder adds little practical value, and required additional API calls every time a
 transaction was build.
 
-#### Cloning a Transaction
+#### Cloning a transaction
 
 Cloning a transaction can now be done the `transaction.from` rather than the TransactionBlock
 constructor:
@@ -177,16 +177,16 @@ The `getPureSerializationType` utility function has been removed.
 
 ## `@mysten/sui/bcs`
 
-### Bcs Types
+### BCS types
 
-Many of the BCS type definitions exported from the Typescript SDK have been updated to more closely
+Many of the BCS type definitions exported from the TypeScript SDK have been updated to more closely
 align with the Rust definitions. If you were using these types to parse transactions from BCS, you
-may find that some of the data structures have been updated.
+might find that some of the data structures have been updated.
 
 We have also removed some redundant exports that mirror the exported BCS types. These types often
-conflicted with other types in the Typescript SDK, leading to confusion about which version to use.
+conflicted with other types in the TypeScript SDK, leading to confusion about which version to use.
 
-The correct way to get Typescript types for the exported BCS types is to use the $inferType type
+The correct way to get TypeScript types for the exported BCS types is to use the $inferType type
 helper:
 
 ```ts
@@ -196,12 +196,12 @@ function callArg(arg: typeof bcs.CallArg.$inferType) {
 }
 ```
 
-## /utils
+## `/utils`
 
 The typescript SDK no longer uses `superstruct` for type validation, so the `is` and `assert`
 helpers have been removed.
 
-## /multisig
+## `/multisig`
 
 The `publicKeyFromSuiBytes` has been moved to `@mysten/sui/verify`
 
@@ -225,9 +225,9 @@ The methods for verifying signatures have been renamed
 + } from '@mysten/sui/verify'
 ```
 
-## /cryptography
+## `/cryptography`
 
-The `signData` method has been removed from Signers and Keypair classes. Use `sign` instead.
+The `signData` method has been removed from `Signers` and `Keypair` classes. Use `sign` instead.
 
 ```diff
 - keypair.signData(data)
@@ -240,7 +240,7 @@ return the unwrapped bytes of the message that was signed
 
 # @mysten/bcs
 
-## The Registry
+## The registry
 
 We have removed the previously deprecated registry from the BCS library. The registry was removed
 from the documentation when BCS was re-written last year, and is now being removed entirely.
@@ -255,7 +255,7 @@ Previously the `size` option was used both as an initial size and a maximum size
 writer instance. We replaced the `size` option with a new `initialSize` option, and have updated
 `maxSize` to default to Infinity rather than defaulting to `size`.
 
-## new methods on BcsType
+## New methods on `BcsType`
 
 We have added `fromBase64`, `fromBase58`, and `fromHex` methods to `BcsType` instances, making it
 easier to parse BCS data from various string encodings.
@@ -292,7 +292,7 @@ if (parsed.Variant0 !== undefined) {
 }
 ```
 
-# @mysten/kiosk
+## `@mysten/kiosk`
 
 The options passed to `KioskTransaction` and `TransferPolicyTransaction` have been updated to
 replace `transactionBlock` with `transaction`.
@@ -313,7 +313,7 @@ than the `transactionBlock`.
 + resolveRuleFunction({ transaction }) => { ... }
 ```
 
-# @mysten/enoki
+## `@mysten/enoki`
 
 The Enoki SDK has been updated to replace TransactionBlock terminology with Transaction throughout
 the API:
@@ -335,9 +335,9 @@ the API:
 + enokiClient.executeSponsoredTransaction({ ... })
 ```
 
-# dapp-kit
+## `dapp-kit`
 
-## `useSignTransactionBlock`
+### `useSignTransactionBlock`
 
 The `useSignTransactionBlock` has been named to `useSignTransaction` and now returns bytes instead
 of transactionBlockBytes
@@ -350,7 +350,7 @@ of transactionBlockBytes
 + const { signature, bytes } = await signTransaction({ transaction })
 ```
 
-## `useSignAndExecuteTransactionBlock`
+### `useSignAndExecuteTransactionBlock`
 
 The `useSignAndExecuteTransactionBlock` has been named to `useSignAndExecuteTransaction` and
 redesigned to work the updated wallet-standard methods.
@@ -358,8 +358,8 @@ redesigned to work the updated wallet-standard methods.
 `useSignAndExecuteTransaction` no-longer accepts the options passed to
 `suiClient.executeTransactionBlock` for returning additional data.
 
-By default useSignAndExecuteTransactionBlock will now return an object with the transaction `digest`
-and the bcs encoded transaction effects:
+By default `useSignAndExecuteTransactionBlock` will now return an object with the transaction
+`digest` and the BCS encoded transaction effects:
 
 ```ts
 const { mutate: signAndExecuteTransaction } = useSignAndExecuteTransaction()
@@ -397,16 +397,16 @@ To fetch additional data, you can provide a customized `execute` function:
 + });
 ```
 
-When using a custom `execute` function, the you must return the rawEffects by setting
+When using a custom `execute` function, the you must return the `rawEffects` by setting
 `showRawEffects` to true if using `suiClient.executeTransactionBlock`, or by returning an object
-matching `{ effects: { bcs: string` } }` with the base64 encoded bcs effects when using a GraphQL
+matching `{ effects: { bcs: string` } }` with the base64 encoded BCS effects when using a GraphQL
 query to execute the transaction.
 
 This change decouples the `useSignAndExecuteTransaction` hook from a specific RPC API
 implementation, and will enable migration to GraphQL without additional breaking changes in this
 hook.
 
-# @mysten/zksend
+## `@mysten/zksend`
 
 The `getSentTransactionBlocksWithLinks` method has been renamed to `getSentTransactionsWithLinks`,
 and all methods that previously accepted a `transactionBlock` option now accept a `transaction`
@@ -427,7 +427,7 @@ instead instead.
   });
 ```
 
-# @mysten/wallet-standard
+## `@mysten/wallet-standard`
 
 ### New wallet-standard features
 
@@ -436,16 +436,16 @@ Transactions in wallets without waiting for previous transactions to be indexed
 API.
 
 For more details on how wallets can take advantage of these features, see the
-[wallet-standard documentation](https://docs.sui.io/standards/wallet-standard).
+[`wallet-standard` documentation](https://docs.sui.io/standards/wallet-standard).
 
 The old `sui:signTransactionBlock` and `sui:signAndExecuteTransactionBlock` methods have been
 deprecated in favor of the new `sui:signTransaction` and `sui:signAndExecuteTransaction` methods,
 but wallets should continue to implement these deprecated methods until the new methods have been
-broadly adopted by dapps.
+broadly adopted by apps.
 
-### helpers
+### Helpers
 
-2 new helpers have been added to make it easier for dapps to handle wallets that have implemented
+2 new helpers have been added to make it easier for apps to handle wallets that have implemented
 either the new or old wallet-standard methods: `signTransaction` and `signAndExecuteTransaction`.
 
 ```ts

package/dist/sui/migrations/sui-2.0/agent-prompt.md

@@ -1,9 +1,9 @@
 # Agent Migration Prompt
 
-> AI agent prompt for automated SDK 2.0 migration
+> AI agent prompt for automated SDK 2.0 migration of your codebase.
 
-Copy and paste the following prompt into your AI coding assistant (Claude Code, Cursor, etc.) to
-migrate your codebase to v2. If a planning mode is available we recommend starting there first.
+Copy and paste the following prompt into your AI coding assistant (Claude Code, Cursor, and others)
+to migrate your codebase to v2. If a planning mode is available we recommend starting there first.
 
 ```txt
 ## Sui TypeScript SDK v2 Migration

package/dist/sui/migrations/sui-2.0/dapp-kit.md

@@ -1,6 +1,6 @@
 # @mysten/dapp-kit
 
-> Migrate @mysten/dapp-kit to 2.0
+> Migrate @mysten/dapp-kit to the new dapp-kit-react package in 2.0.
 
 This guide helps you migrate from the original `@mysten/dapp-kit` (legacy) to the new
 `@mysten/dapp-kit-react` package.
@@ -11,20 +11,20 @@ This guide helps you migrate from the original `@mysten/dapp-kit` (legacy) to th
 
 ## Overview
 
-The new dApp Kit SDK represents a complete rewrite with these key changes:
+The new dApp kit SDK represents a complete rewrite with these key changes:
 
-- **Framework agnostic**: Split into `@mysten/dapp-kit-core` (framework-agnostic) and
+- Framework agnostic: Split into `@mysten/dapp-kit-core` (framework-agnostic) and
   `@mysten/dapp-kit-react` (React bindings)
-- **No React Query dependency**: Direct promise-based API instead of mutation hooks
-- **Web Components**: UI components built with Lit Elements for cross-framework compatibility
-- **Smaller bundle size**: No React Query dependency, lighter state management with nanostores
-- **Better SSR support**: Compatible with SSR frameworks like Next.js
-- **Cross-framework compatibility**: Core functionality can be used in vanilla JS, Vue, React, and
-  other frameworks
+- No React Query dependency: Direct promise-based API instead of mutation hooks
+- Web Components: UI components built with Lit Elements for cross-framework compatibility
+- Smaller bundle size: No React Query dependency, lighter state management with nanostores
+- Better SSR support: Compatible with SSR frameworks like Next.js
+- Cross-framework compatibility: Core functionality can be used in vanilla JS, Vue, React, and other
+  frameworks
 
-## Step-by-Step Migration
+## Step-by-step migration
 
-### 1. Update Dependencies
+### Step 1: Update dependencies
 
 Remove the old package and install the new ones:
 
@@ -33,9 +33,9 @@ npm uninstall @mysten/dapp-kit
 npm i @mysten/dapp-kit-react @mysten/dapp-kit-core @mysten/sui
 ```
 
-### 2. Create dApp Kit Instance
+### Step 2: Create dApp Kit instance
 
-Create a new instance of the dApp Kit using the `createDAppKit` function and register the global
+Create a new instance of the dApp kit using the `createDAppKit` function and register the global
 type.
 
 ```tsx
@@ -59,12 +59,12 @@ declare module '@mysten/dapp-kit-react' {
 }
 ```
 
-### 3. Register Types
+### Step 3: Register types
 
-The `declare module` block in the previous step registers your dApp Kit instance's type globally.
+The `declare module` block in the previous step registers your dApp kit instance's type globally.
 This enables all hooks like `useDAppKit()`, `useCurrentNetwork()`, and `useCurrentClient()` to
-automatically infer the correct types based on your configuration (e.g., your specific networks and
-client type).
+automatically infer the correct types based on your configuration (for example, your specific
+networks and client type).
 
 ```tsx
 declare module '@mysten/dapp-kit-react' {
@@ -83,9 +83,9 @@ const connection = useWalletConnection({ dAppKit });
 const network = useCurrentNetwork({ dAppKit });
 ```
 
-### 4. Replace Provider Setup
+### Step 4: Replace provider setup
 
-Replace the nested dApp Kit providers with a single unified provider. You can keep your existing
+Replace the nested dApp kit providers with a single unified provider. You can keep your existing
 `QueryClientProvider` for data fetching.
 
 ```diff
@@ -117,7 +117,7 @@ Replace the nested dApp Kit providers with a single unified provider. You can ke
   }
 ```
 
-### 5. Configuration Option Changes
+### Step 5: Configuration option changes
 
 The `createDAppKit` function has different configuration options than the old `WalletProvider`:
 
@@ -136,24 +136,24 @@ The `createDAppKit` function has different configuration options than the old `W
 | `theme`                | -                     | Removed (UI components are now web components with built-in styling) |
 | -                      | `walletInitializers`  | New option for registering custom wallets                            |
 
-### 6. Update Hook Usage
+### Step 6: Update hook usage
 
-The new dApp Kit has a dramatically simplified hook API. Most hooks from the original version have
+The new dApp kit has a dramatically simplified hook API. Most hooks from the original version have
 been replaced with direct action calls through `useDAppKit()`.
 
 **Available hooks in the new version:**
 
-- `useDAppKit()` - Access the dAppKit instance for calling actions
-- `useCurrentClient()` - Get the blockchain client (renamed from `useSuiClient`)
-- `useCurrentAccount()` - Get the current connected account
-- `useCurrentWallet()` - Get the current connected wallet
-- `useWallets()` - Get the list of available wallets
-- `useWalletConnection()` - Get the current wallet connection status
-- `useCurrentNetwork()` - Get the current network
+- `useDAppKit()`: Access the dAppKit instance for calling actions
+- `useCurrentClient()`: Get the blockchain client (renamed from `useSuiClient`)
+- `useCurrentAccount()`: Get the current connected account
+- `useCurrentWallet()`: Get the current connected wallet
+- `useWallets()`: Get the list of available wallets
+- `useWalletConnection()`: Get the current wallet connection status
+- `useCurrentNetwork()`: Get the current network
 
 **Removed hooks:**
 
-All wallet action hooks have been replaced with direct action calls via `useDAppKit()`:
+All wallet action hooks have been replaced with direct action calls through `useDAppKit()`:
 
 - `useConnectWallet` -> Use `dAppKit.connectWallet()`
 - `useDisconnectWallet` -> Use `dAppKit.disconnectWallet()`
@@ -176,16 +176,16 @@ Other removed hooks:
 - `useAccounts` -> Use `useWalletConnection()` to access `connection.wallet.accounts`
 - `useWalletStore` -> Use specific hooks like `useWalletConnection()` instead
 
-### 7. Replace Mutation Patterns
+### Step 7: Replace mutation patterns
 
 The built-in mutation hooks have been removed. Use TanStack Query's `useMutation` with
 `useDAppKit()` to get similar functionality.
 
 **Chain parameter replaced with network:**
 
-In the old dapp-kit, you could optionally pass a `chain` parameter (e.g., `sui:mainnet`) to methods
-like `signTransaction` and `signAndExecuteTransaction`. In the new dapp-kit, use the `network`
-parameter instead - the chain is automatically derived from the network.
+In the old dApp kit, you could optionally pass a `chain` parameter (for example, `sui:mainnet`) to
+methods like `signTransaction` and `signAndExecuteTransaction`. In the new dApp kit, use the
+`network` parameter instead - the chain is automatically derived from the network.
 
 ```diff
 - const { mutateAsync: signAndExecute } = useSignAndExecuteTransaction();
@@ -249,7 +249,7 @@ If you don't need React Query's state management, you can call `dAppKit` methods
 }
 ```
 
-### 8. Replace Data Fetching Patterns
+### Step 8: Replace data fetching patterns
 
 The built-in data fetching hooks have been removed. Use TanStack Query's `useQuery` with
 `useCurrentClient()` to get similar functionality:
@@ -295,9 +295,9 @@ If you don't need React Query's caching and state management, you can fetch data
 }
 ```
 
-### 9. Update The Remaining Code
+### Step 9: Update the remaining code
 
-The following hooks from the original dApp Kit are not available anymore:
+The following hooks from the original dApp kit are not available anymore:
 
 - `useSuiClientQuery` → Use `useQuery` from `@tanstack/react-query`
 - `useSuiClientMutation` → Use `useMutation` from `@tanstack/react-query`
@@ -305,7 +305,7 @@ The following hooks from the original dApp Kit are not available anymore:
 - `useResolveSuiNSNames` → Use `useCurrentClient()` with the suins extension
 
 > **Warning:** The `reportTransactionEffects` feature is planned for deprecation in the [Wallet
-> Standard](https://docs.sui.io/standards/wallet-standard) and so the dApp Kit provides no
+> Standard](https://docs.sui.io/standards/wallet-standard) and so the dApp kit provides no
 > replacement.
 
 The following have been removed:
@@ -314,18 +314,18 @@ The following have been removed:
 - `reportTransactionEffects` callback from `useSignTransaction`
 - Automatic transaction effects reporting from `useSignAndExecuteTransaction`
 
-## CSS and Theming Changes
+## CSS and theming changes
 
-The new dApp Kit no longer bundles a CSS file. If you were importing the old CSS file, remove the
+The new dApp kit no longer bundles a CSS file. If you were importing the old CSS file, remove the
 import:
 
 ```diff
 - import '@mysten/dapp-kit/dist/full/index.css';
 ```
 
-The new dApp Kit uses web components with built-in styling that can be customized using CSS custom
+The new dApp kit uses web components with built-in styling that can be customized using CSS custom
 properties. See the [Theming documentation](/dapp-kit/theming) for details on customizing the
-appearance of dApp Kit components.
+appearance of dApp kit components.
 
 **Quick theme setup:**
 
@@ -342,7 +342,7 @@ appearance of dApp Kit components.
 
 ## Removing TanStack Query
 
-If you were only using `@tanstack/react-query` for dApp Kit and don't need it for other parts of
+If you were only using `@tanstack/react-query` for dApp kit and don't need it for other parts of
 your application, you can now remove it:
 
 ```bash

package/dist/sui/migrations/sui-2.0/deepbook-v3.md

@@ -1,6 +1,6 @@
 # @mysten/deepbook-v3
 
-> Migrate @mysten/deepbook-v3 to 2.0
+> Migrate @mysten/deepbook-v3 to 2.0 with client extension pattern.
 
 This package now exports a client extension that integrates with Sui clients.
 

package/dist/sui/migrations/sui-2.0/index.md

@@ -1,6 +1,6 @@
 # Migrate to 2.0
 
-> Migration guide for Sui TypeScript SDK 2.0
+> Migration guide for Sui TypeScript SDK 2.0 covering all @mysten packages.
 
 This guide covers the breaking changes across the latest release of all the `@mysten/*` packages.
 
@@ -9,24 +9,24 @@ SDKs. These releases also include removals of deprecated APIs, some renaming for
 and significant internal refactoring to improve maintainability. Starting with this release, Mysten
 packages will now be published as ESM only packages.
 
-## Quick Reference
+## Quick reference
 
 | Package                                                               | Key Changes                                                                              |
 | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| [@mysten/sui](/sui/migrations/sui-2.0/sui)                            | Client API stabilization, SuiClient removal, BCS schema alignment, transaction executors |
-| [@mysten/dapp-kit](/sui/migrations/sui-2.0/dapp-kit)                  | Complete rewrite with framework-agnostic core                                            |
-| [@mysten/kiosk](/sui/migrations/sui-2.0/kiosk)                        | Client extension pattern, low-level helpers removed, KioskTransaction pattern            |
-| [@mysten/zksend](/sui/migrations/sui-2.0/zksend)                      | Client extension pattern                                                                 |
-| [@mysten/suins](/sui/migrations/sui-2.0/suins)                        | Client extension pattern                                                                 |
-| [@mysten/deepbook-v3](/sui/migrations/sui-2.0/deepbook-v3)            | Client extension pattern                                                                 |
-| [@mysten/walrus](/sui/migrations/sui-2.0/walrus)                      | Client extension pattern, requires client instead of RPC URL                             |
-| [@mysten/seal](/sui/migrations/sui-2.0/seal)                          | Client extension pattern                                                                 |
-| [@mysten/wallet-standard](/sui/migrations/sui-2.0/wallet-builders)    | Removal of reportTransactionEffects, new core API response format                        |
+| [`@mysten/sui`](/sui/migrations/sui-2.0/sui)                          | Client API stabilization, SuiClient removal, BCS schema alignment, transaction executors |
+| [`@mysten/dapp-kit`](/sui/migrations/sui-2.0/dapp-kit)                | Complete rewrite with framework-agnostic core                                            |
+| [`@mysten/kiosk`](/sui/migrations/sui-2.0/kiosk)                      | Client extension pattern, low-level helpers removed, KioskTransaction pattern            |
+| [`@mysten/zksend`](/sui/migrations/sui-2.0/zksend)                    | Client extension pattern                                                                 |
+| [`@mysten/suins`](/sui/migrations/sui-2.0/suins)                      | Client extension pattern                                                                 |
+| [`@mysten/deepbook-v3`](/sui/migrations/sui-2.0/deepbook-v3)          | Client extension pattern                                                                 |
+| [`@mysten/walrus`](/sui/migrations/sui-2.0/walrus)                    | Client extension pattern, requires client instead of RPC URL                             |
+| [`@mysten/seal`](/sui/migrations/sui-2.0/seal)                        | Client extension pattern                                                                 |
+| [`@mysten/wallet-standard`](/sui/migrations/sui-2.0/wallet-builders)  | Removal of reportTransactionEffects, new core API response format                        |
 | [Migrating from JSON-RPC](/sui/migrations/sui-2.0/json-rpc-migration) | Migrate from deprecated JSON-RPC to gRPC and GraphQL                                     |
 
-## Common Migration Patterns
+## Common migration patterns
 
-### ESM Migration
+### ESM migration
 
 All `@mysten/*` packages are now ESM only. If your project does not already use ESM, you will need
 to add `"type": "module"` to your `package.json`:
@@ -49,13 +49,13 @@ need to update your `tsconfig.json` to use `"NodeNext"`, `"Node16"`, or `"Bundle
 }
 ```
 
-This enables proper resolution of the SDK's subpath exports (e.g., `@mysten/sui/client`,
+This enables proper resolution of the SDK's subpath exports (for example, `@mysten/sui/client`,
 `@mysten/sui/transactions`).
 
-If you maintain a library that depends on any of the `@mysten/*` packages, you may also need to
+If you maintain a library that depends on any of the `@mysten/*` packages, you might also need to
 update your library to be ESM only to ensure it works correctly everywhere.
 
-Applications using bundlers and recent Node.js versions (>=22) may still work when using `require`
+Applications using bundlers and recent Node.js versions (>=22) might still work when using `require`
 to load ESM packages, but we recommend migrating to ESM.
 
 **Why ESM only?** Many packages in the ecosystem (specifically critical cryptography dependencies)
@@ -63,7 +63,7 @@ are now published as ESM only. Supporting CommonJS has prevented us from using t
 of these dependencies, making our SDKs harder to maintain and risking missing critical security
 updates.
 
-### Client Migration
+### Client migration
 
 The most common change across all SDKs is migrating from `SuiClient` to `SuiJsonRpcClient`:
 
@@ -78,7 +78,7 @@ The most common change across all SDKs is migrating from `SuiClient` to `SuiJson
 + });
 ```
 
-We also recommend moving from the deprecated JSON RPC Apis to the new gRPC API as soon as possible:
+We also recommend moving from the deprecated JSON RPC APIs to the new gRPC API as soon as possible:
 
 ```diff
 - import { SuiJsonRpcClient } from '@mysten/sui/jsonRpc';
@@ -91,7 +91,7 @@ We also recommend moving from the deprecated JSON RPC Apis to the new gRPC API a
 The gRPC runs on full nodes so in most cases you should be able to use the same URLs when migrating
 to gRPC.
 
-### Network Parameter Required
+### Network parameter required
 
 All client constructors now require an explicit `network` parameter:
 
@@ -112,7 +112,7 @@ const grpcClient = new SuiGrpcClient({
 });
 ```
 
-### ClientWithCoreApi Interface
+### `ClientWithCoreApi` Interface
 
 Many SDK methods now accept any client implementing `ClientWithCoreApi`, enabling use with JSON-RPC,
 GraphQL, or gRPC transports:
@@ -125,34 +125,34 @@ const graphqlClient = new SuiGraphQLClient({ url, network: 'mainnet' });
 const grpcClient = new SuiGrpcClient({ baseUrl, network: 'mainnet' });
 ```
 
-## Package-Specific Guides
+## Package-specific guides
 
 For detailed migration instructions, see the SDK-specific guides:
 
-- **[@mysten/sui](/sui/migrations/sui-2.0/sui)** - Core SDK changes including client API, BCS
+- **[`@mysten/sui`](/sui/migrations/sui-2.0/sui):** Core SDK changes including client API, BCS
   schemas, transactions, zkLogin, and GraphQL
-- **[@mysten/dapp-kit](/sui/migrations/sui-2.0/dapp-kit)** - Complete migration guide for the new
-  dApp Kit architecture
-- **[@mysten/kiosk](/sui/migrations/sui-2.0/kiosk)** - Kiosk SDK now exports a client extension,
+- **[`@mysten/dapp-kit`](/sui/migrations/sui-2.0/dapp-kit):** Complete migration guide for the new
+  dApp kit architecture
+- **[`@mysten/kiosk`](/sui/migrations/sui-2.0/kiosk):** Kiosk SDK now exports a client extension,
   low-level helpers removed
-- **[@mysten/zksend](/sui/migrations/sui-2.0/zksend)** - zkSend SDK now exports a client extension
-- **[@mysten/suins](/sui/migrations/sui-2.0/suins)** - SuiNS now exports a client extension
-- **[@mysten/deepbook-v3](/sui/migrations/sui-2.0/deepbook-v3)** - DeepBook DEX now exports a client
+- **[`@mysten/zksend`](/sui/migrations/sui-2.0/zksend):** zkSend SDK now exports a client extension
+- **[`@mysten/suins`](/sui/migrations/sui-2.0/suins):** SuiNS now exports a client extension
+- **[`@mysten/deepbook-v3`](/sui/migrations/sui-2.0/deepbook-v3):** DeepBook DEX now exports a
+  client extension
+- **[`@mysten/walrus`](/sui/migrations/sui-2.0/walrus):** Walrus storage now exports a client
   extension
-- **[@mysten/walrus](/sui/migrations/sui-2.0/walrus)** - Walrus storage now exports a client
-  extension
-- **[@mysten/seal](/sui/migrations/sui-2.0/seal)** - Seal encryption now exports a client extension
+- **[`@mysten/seal`](/sui/migrations/sui-2.0/seal):** Seal encryption now exports a client extension
 
-## Transport Migration
+## Transport migration
 
-- **[Migrating from JSON-RPC](/sui/migrations/sui-2.0/json-rpc-migration)** - Migrate from the
+- **[Migrating from JSON-RPC](/sui/migrations/sui-2.0/json-rpc-migration):** Migrate from the
   deprecated JSON-RPC client to gRPC and GraphQL
 
-## Ecosystem Migration Guides
+## Ecosystem migration guides
 
 For wallet builders and SDK maintainers building on the Sui ecosystem:
 
-- **[Wallet Builders](/sui/migrations/sui-2.0/wallet-builders)** - Guide for wallet implementations
+- **[Wallet builders](/sui/migrations/sui-2.0/wallet-builders):** Guide for wallet implementations
   adapting to `reportTransactionEffects` removal and new core API response format
-- **[SDK Maintainers](/sui/migrations/sui-2.0/sdk-maintainers)** - Guide for SDK authors migrating
-  to `ClientWithCoreApi` and the new transport-agnostic architecture
+- **[SDK maintainers](/sui/migrations/sui-2.0/sdk-maintainers):** Guide for SDK authors migrating to
+  `ClientWithCoreApi` and the new transport-agnostic architecture