Skip to content

Commit 02414ea

Browse files
authored
docs: fix codemod callout wording and add setup steps (#128)
## Summary - Remove incorrect `@layer-3/nitrolite` references from codemod callouts (that package was never published; old SDK was only `@erc7824/nitrolite`) - Add explicit clone + install steps to the overview collapsible so the CLI commands have proper context Follows up on #127. ## Test plan - [ ] Verify both `.mdx` pages render correctly in Docusaurus
1 parent 295acfc commit 02414ea

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/build/sdk/typescript-compat/migration-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide explains how to migrate your Nitrolite dApp from the v0.5.3 SDK to th
1313
A direct migration from v0.5.3 to v1.0.0 touches **20+ files** per app with deep, scattered rewrites. The compat layer reduces this to **~5 file changes** per app.
1414

1515
:::tip Automate with Codemod
16-
Before migrating manually, try the [yellow-sdk-codemod](https://github.com/layer-3/yellow-sdk-codemod). It rewrites imports, renames auth fields, migrates client constructors, updates `package.json`, and flags RPC patterns with `// TODO [codemod]` comments for the remaining manual steps.
16+
Before migrating manually, try the [yellow-sdk-codemod](https://github.com/layer-3/yellow-sdk-codemod). It rewrites `@erc7824/nitrolite` imports, renames auth fields, migrates client constructors, updates `package.json`, and flags RPC patterns with `// TODO [codemod]` comments for the remaining manual steps.
1717
:::
1818

1919
## Installation

docs/build/sdk/typescript-compat/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ sidebar_position: 1
99
Compatibility layer that bridges the Nitrolite SDK **v0.5.3 API** to the **v1.0.0 runtime**, letting existing dApps upgrade to the new protocol with minimal code changes.
1010

1111
<details>
12-
<summary><strong>Already integrated with <code>@erc7824/nitrolite</code> or <code>@layer-3/nitrolite</code>?</strong></summary>
12+
<summary><strong>Already integrated with <code>@erc7824/nitrolite</code>?</strong></summary>
1313

14-
If your app is already built on `@erc7824/nitrolite` (v0.4 through v0.5.3) or `@layer-3/nitrolite`, you can speed up the migration using the [yellow-sdk-codemod](https://github.com/layer-3/yellow-sdk-codemod) tool. It handles the repetitive parts of the upgrade automatically: rewriting imports, migrating client constructors, renaming auth fields, and updating your `package.json`. Where the change requires context (collapsing RPC call chains, removing manual WebSocket setup), the codemod leaves a `// TODO [codemod]` comment with the exact replacement so you know what to do.
14+
If your app is already built on `@erc7824/nitrolite` (v0.4 through v0.5.3), you can speed up the migration using the [yellow-sdk-codemod](https://github.com/layer-3/yellow-sdk-codemod) tool. It handles the repetitive parts of the upgrade automatically: rewriting imports, migrating client constructors, renaming auth fields, and updating your `package.json`. Where the change requires context (collapsing RPC call chains, removing manual WebSocket setup), the codemod leaves a `// TODO [codemod]` comment with the exact replacement so you know what to do.
1515

1616
```bash
1717
# Clone the codemod and install its dependencies

0 commit comments

Comments
 (0)