Remove git submodules, replace with external links#3169
Open
Remove git submodules, replace with external links#3169
Conversation
Remove arbitrum-sdk and stylus-by-example submodule infrastructure: - Delete init-submodules.sh, sdkDocsHandler.ts, stylusByExampleDocsHandler.ts, sdk-sidebar-generator.js - Remove typedoc plugin config from docusaurus.config.js - Remove SDK/stylus-by-example sidebar imports and replace with external links - Clean up .gitignore entries for generated SDK/stylus content - Remove install-sdk-dependencies from package.json scripts
- vercel.json: remove init-submodules.sh from install command, redirect 53 dead /sdk/ destinations to GitHub repo - Replace broken relative ../sdk/ doc links with GitHub source links - dependabot.yml: replace gitsubmodule with npm ecosystem - README.md: remove submodule setup instructions and references - dependencies.json: remove arbitrum-sdk entry with dead docsPath
The arbitrum-sdk repo moved from src/lib/ to packages/sdk/src/lib/. Also update renamed file L1ToL2MessageGasEstimator.ts → ParentToChildMessageGasEstimator.ts.
- Rename L1ToL2MessageGasEstimator → ParentToChildMessageGasEstimator - Rename calculateSubmitRetryableId → ParentToChildMessage.calculateSubmitRetryableId - Update InboxTools links to main branch with correct packages/sdk path - Update code comments to use Parent/Child terminology - Change L1ToL2MessageStatus → ParentToChildMessageStatus in examples - Note Layer Leap uses SDK v3 teleporter package
Replace broken internal markdown links in docs/sdk/index.mdx and docs/sdk/migrate.mdx with GitHub URLs now that the auto-generated SDK docs have been removed along with the submodule.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Restore @floating-ui/react, @ethersproject/address, and mermaid which are still used by components added to master after the branch diverged. Regenerate yarn.lock to match package.json.
The rebase introduced 189 missing redirects, 172 wrong destinations, 39 duplicate sources, and stale orbit references. Reset to master's redirects and kept only the intentional installCommand change.
docusaurus.config.js, .github/dependabot.yml, package.json, and yarn.lock were corrupted during rebase — losing inkeep analytics, parseFrontMatter, onBrokenAnchors, and adding unrelated deps like vitest. Reset all to master and re-applied only the intentional submodule-removal changes.
Applies pete-vielhaber's 7 review suggestions to use precise line number anchors instead of fragment-based anchors in SDK source links.
Contributor
That looks good to me, but I think we should discuss how to document the Arbitrum SDK references; removing them entirely and leaving a link might be too radical. |
Fix missing space before ArbitrumNetwork link in TokenBridge section.
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
3 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
arbitrum-sdkandstylus-by-examplegit submodulesscripts/init-submodules.sh,scripts/sdkDocsHandler.ts, andscripts/sdk-sidebar-generator.jsdocusaurus.config.jsstylus-by-example.orgvercel.jsonso installs no longer run submodule initREADME.md,dependencies.json,.gitignore,.gitmodules,package.json, andyarn.lockvercel.jsonanddocusaurus.config.jsMotivation
The submodules added build and CI complexity for content that already has better canonical homes. This change removes the submodule-specific install and docs-generation path while keeping users pointed at the maintained upstream sources.
What Stays
@arbitrum/sdknpm dependency remains because it is still used at runtime bysrc/components/AddressAliasHelper.tsx/sdk/...traffic is still handled via redirects to the SDK GitHub repoReview Notes
vercel.jsonanddocusaurus.config.jswas reset to trunk and the intended submodule-removal changes were re-applied cleanlyValidation
yarn buildBuild,Install,test,Check Formatting,Vercel,license/cla