Conversation
Remove arbitrum-sdk and stylus-by-example submodules, committing their generated output (SDK API docs, Stylus examples, sidebars) directly. Build simplifies to just `docusaurus build` — no submodule init, SDK dependency install, or TypeDoc generation at build time. Add GitHub Actions workflow (update-external-content.yml) for manual regeneration from upstream repos via workflow_dispatch.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Regenerate SDK docs from latest arbitrum-sdk (monorepo structure) and sync stylus-by-example content from latest upstream. Also fix: update sdkDocsHandler to clean up TypeDoc-generated README.md, fix sidebar reference from sdk/index to sdk/sdk-intro, and update CI workflow for SDK monorepo paths.
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
1 participant
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 submodules, committing their generated output directly (SDK API docs, Stylus examples, sidebar configs)docusaurus build— no submodule init, SDK dependency install, or TypeDoc generation at build timeupdate-external-content.ymlGitHub Actions workflow for manual regeneration from upstream repos viaworkflow_dispatchWhat changed
yarn install-sdk-dependencies && yarn sync-stylus-content && docusaurus builddocusaurus buildbash scripts/init-submodules.sh && yarn installyarn installsubmodules: recursiveyarn startyarn startFiles modified
.gitignore— un-ignoresdk-sidebar.js,docs/sdk/,docs/stylus-by-example/docusaurus.config.js— removedocusaurus-plugin-typedocplugin blockpackage.json— simplifybuild/start, remove submodule-related scriptsvercel.json— simplifyinstallCommand.github/workflows/build.yml— removesubmodules: recursivescripts/sync-stylus-content.js— addSTYLUS_SOURCE_DIRenv var for CIFiles added
docs/sdk/**/*.md— 28 SDK API reference docs (previously generated at build time)docs/stylus-by-example/**— 22 Stylus example docs + sidebarssdk-sidebar.js— SDK sidebar config.github/workflows/update-external-content.yml— content update workflowFiles deleted
.gitmodules,scripts/init-submodules.sh,submodules/*Test plan
yarn buildsucceeds with committed content only (no submodules)init-submodules.sh