docs: add yellow-sdk-codemod reference to compat SDK pages#127
Merged
docs: add yellow-sdk-codemod reference to compat SDK pages#127
Conversation
Add callout boxes linking to the codemod tool on the compat overview and migration overview pages so developers migrating from v0.5.3 can discover and use the automated migration tooling.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdded documentation blocks to two TypeScript SDK compatibility docs describing the yellow-sdk-codemod and guidance for automated migration; no functional code or runtime changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/build/sdk/typescript-compat/overview.mdx`:
- Around line 233-247: Update the codemod link and tip block in overview.mdx to
warn that the GitHub repo (https://github.com/layer-3/yellow-sdk-codemod) is
private or requires Layer 3 org access: amend the sentence that introduces the
codemod and the "Codemod available" tip to include a brief accessibility note
such as "Requires Layer 3 organization access" or replace the link with a public
alternative, and ensure the accompanying code example remains but is prefixed by
the accessibility note so readers know why the link may 404.
- Around line 238-244: Update the codemod usage instructions to include setup
and canonical invocation: explain how to obtain the codemod (either install via
npm/yarn with the package name or clone the repo and run npm install), then show
the canonical command to run the tool (replace the local path invocations like
`npx tsx src/cli.ts scan` and `npx tsx src/cli.ts run` with the published
package invocation or a repo-local invocation after cloning), and include any
prerequisite steps (e.g., git clone <repo>, cd <repo>, npm install) so readers
can reproduce the `scan` and `run` commands reliably.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c39c2792-c2b7-4b04-9685-b38540d8612c
📒 Files selected for processing (2)
docs/build/sdk/typescript-compat/migration-overview.mdxdocs/build/sdk/typescript-compat/overview.mdx
… context Move the codemod reference to a collapsible section right below the page intro so returning developers see it first. Add clone and install steps so the CLI invocation makes sense without prior context.
Enhance the codemod section by adding detailed steps for cloning and installing the tool, and clarify the scanning and transformation commands for better usability during the migration from v0.5.3 to v1.0.0.
alessio
approved these changes
Mar 13, 2026
1 task
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 13, 2026
## 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
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
2 participants
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
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-compatmigration.Screengrabs
Test plan
:::tipadmonition renders correctly on both pagesSummary by CodeRabbit