Skip to content

docs: fix codemod callout wording and add setup steps#128

Merged
ihsraham merged 1 commit intomasterfrom
docs/codemod-callout-fixes
Mar 13, 2026
Merged

docs: fix codemod callout wording and add setup steps#128
ihsraham merged 1 commit intomasterfrom
docs/codemod-callout-fixes

Conversation

@ihsraham
Copy link
Collaborator

@ihsraham ihsraham commented 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

Summary by CodeRabbit

  • Documentation
    • Updated TypeScript migration guides to clarify codemod compatibility and specify import rewrite details. Added installation instructions for codemod dependencies.

- Remove @layer-3/nitrolite from callout text (that package name was
  never published; the old SDK was only @erc7824/nitrolite)
- Add explicit clone + npm install steps to overview so codemod CLI
  invocation has proper setup context
@ihsraham ihsraham requested a review from dpatsora as a code owner March 13, 2026 12:47
@coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fec8325f-3393-4aad-a238-4482ce71a15c

📥 Commits

Reviewing files that changed from the base of the PR and between 295acfc and 6bf0b0a.

📒 Files selected for processing (2)
  • docs/build/sdk/typescript-compat/migration-overview.mdx
  • docs/build/sdk/typescript-compat/overview.mdx

📝 Walkthrough

Walkthrough

This PR updates TypeScript compatibility documentation to clarify codemod functionality. Changes specify that the codemod targets @erc7824/nitrolite imports and add installation instructions for codemod dependencies.

Changes

Cohort / File(s) Summary
TypeScript Compatibility Documentation
docs/build/sdk/typescript-compat/migration-overview.mdx, docs/build/sdk/typescript-compat/overview.mdx
Tightens codemod description to specify @erc7824/nitrolite imports instead of generic imports; updates integration-question text to reference only @erc7824/nitrolite; adds code block showing how to clone and install codemod dependencies.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • dpatsora
  • alessio

Poem

🐰 A hop, a skip, the docs are clearer now,
With nitrolite imports we show you how,
Clone and install, the path is bright,
Migration guides made just right!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/codemod-callout-fixes
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ihsraham ihsraham added this pull request to the merge queue Mar 13, 2026
Merged via the queue into master with commit 02414ea Mar 13, 2026
7 of 8 checks passed
@ihsraham ihsraham deleted the docs/codemod-callout-fixes branch March 13, 2026 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant