Commit 295acfc
authored
docs: add yellow-sdk-codemod reference to compat SDK pages (#127)
## Summary
- Adds a callout box to the [TypeScript Compat
Overview](https://docs.yellow.org/docs/build/sdk/typescript-compat/overview)
page with scan/run usage examples and a link to the codemod repo.
- Adds a tip admonition to the [Migration
Overview](https://docs.yellow.org/docs/build/sdk/typescript-compat/migration-overview)
page pointing developers to the codemod before they start migrating
manually.
The codemod tool lives at https://github.com/layer-3/yellow-sdk-codemod
and automates the bulk of the `@erc7824/nitrolite` (v0.4-v0.5.3) to
`@yellow-org/sdk-compat` migration.
## Screengrabs

<img width="1302" height="774" alt="image"
src="https://github.com/user-attachments/assets/5f9e8782-01ab-4fb8-9ff6-7e821b6f9858"
/>
## Test plan
- [ ] Verify the Docusaurus `:::tip` admonition renders correctly on
both pages
- [ ] Confirm the codemod repo link resolves (currently private to the
org)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added a new "Automate with Codemod" tip and a collapsible note for
users already on older Nitrolite packages, guiding automated migration
steps.
* Documented that the codemod automates imports, client constructor
updates, and auth field renames, included example scan/apply commands
and a TODO pointer to follow-up checks and codemod README.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 parent a1fb886 commit 295acfc
3 files changed
Lines changed: 26 additions & 32 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
15 | 19 | | |
16 | 20 | | |
17 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
11 | 32 | | |
12 | 33 | | |
13 | 34 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments