Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Orbit sdk references #1435

Draft
wants to merge 53 commits into
base: master
Choose a base branch
from
Draft

Orbit sdk references #1435

wants to merge 53 commits into from

Conversation

anegg0
Copy link
Contributor

@anegg0 anegg0 commented Jul 14, 2024 •
edited
Loading

This PR introduces generated SDK reference documentation for the Orbit SDK.
It is temporarily on hold until the whole codebase is migrated to mdx (see this PR).

anegg0 added 30 commits June 12, 2024 13:26
@anegg0
feat: add arbitrum-orbit-sdk as submodule
882a518
@anegg0
fix: gitignore generated docs
94f6f4d
@anegg0
fix: re-configuration docusaurus
6bba993
@anegg0
fix: update submodule
21ee952
@anegg0
fix: corrected file path
593b241
@anegg0
fix: tmp add orbit-sdk ref to sidebars
e6bfbf6
@anegg0
feat: add orbitSdkDocsHandler.ts for orbit docgen post-processing
20c0625
@anegg0
fix: corrected gendocs tmp path
f60c151
@anegg0
fix: re-correct gendocs path
9f18c4f
@anegg0
fix: non-verbose log print
59d86b9
@anegg0
fix: correct gitmodule's url
a92fef7
@anegg0
fix: added orbit-sdk submodule install to yarn start
b42a25d
@anegg0
fix: error in yarn invokation
f34dc67
@anegg0
fix: modif submodule's url
72a15ca
@anegg0
fix: change submodule's visibility to public to solve vercel deployment
0c5188c
@anegg0
fix: submodules url
923f752
@anegg0
fix: edited submodule package.json for vercel deployment
3855923
@anegg0
fix: git rm cache
1002526
@anegg0
fix: re-add submodule
1aa111a
@anegg0
fix: re-add /website
294e738
@anegg0
fix: trial deploying on vercel with public property on package.json
fe8d15e
@anegg0
fix: revert to fork of orbit-sdk repo
f25fa83
@anegg0
fix: fix submodule url
76c0667
@anegg0
fix: respin submodules url
7543992
@anegg0
fix: force update submodules
9a2cae6
@anegg0
fix: skiperrorChecking
422cb7d
@anegg0
fix: trying to log vercel's fs
f21ffe5
@anegg0
fix: back to verbose log for vercel debug
279f646
@anegg0
fix: output docgen edit
56c0c76
@anegg0
fix: gitignore orbit sdk gen docs
43409e0
anegg0 and others added 15 commits June 14, 2024 17:17
@anegg0
fix: merge sdkDocsHandlers
9c9d294
@anegg0
fix: tmp version sdkDocsHandler
521cf0b
@anegg0
fix: common sdkDocsHandler file for both arbitrum sdk and orbit sdk
9973122
@anegg0
fix: functional sdk docs generation for both arbitrum sdk
e143951 
and orbit sdk
@anegg0
fix: refactor sdkDocsHandler
7493b98
@anegg0
Merge branch 'master' into 2-iteration-typedoc-orbit-sdk
6783800
@anegg0
fix: commit squash
5984fb5 
Feat: added "Orbit SDK Reference" > sidebars.js + parameters article

fix: rebase

fix: remove deprecated local-stylus-dev-node.mdx

fix: fix conflicts

fix: remove files added in error

fix: removed sidebar items added in error

fix: obsolete links and files extensions
@anegg0
fix: git rm cached
dc7af47
@anegg0
fix: commit squash
47d1c2a 
Feat: added "Orbit SDK Reference" > sidebars.js + parameters article

fix: rebase

fix: remove deprecated local-stylus-dev-node.mdx

fix: fix conflicts

fix: remove files added in error

fix: removed sidebar items added in error

fix: obsolete links and files extensions
@anegg0
fix: sdk revert to master
0965b2d
@anegg0
fix: re-add master version arbitrum-sdk
493ea32
@anegg0
Merge branch 'master' into 2-iteration-typedoc-orbit-sdk
f5b9e8c
@anegg0
fix: update yarn.lock post reinstall orbit-sdk submodule
b1ff6ac
@anegg0
fix: update website/yarn.lock
23026dd
@anegg0
Merge branch 'md-to-mdx' into Orbit-SDK
ef2bb37
@vercel Vercel
Copy link

vercel bot commented Jul 14, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
arbitrum-docs ✅ Ready (Inspect) Visit Preview Jul 16, 2024 6:37pm

@cla-bot cla-bot bot added the s label Jul 14, 2024
@anegg0 anegg0 self-assigned this Jul 15, 2024
anegg0 added 2 commits July 16, 2024 11:34
@anegg0
fix: squash commits
15a62e4 
fix: add node_modules to gitignore

fix: untrack arbitrum-orbit-sdk

fix: gitmodules url extensions

fix: update gitignore to ignore arbitrum-orbit-sdk

fix: update yarn.lock
@anegg0
fix: re-add arbitrum-orbit-sdk
2788aaf
@anegg0 anegg0 force-pushed the Orbit-SDK-References branch from 6eb740f to 2788aaf Compare July 16, 2024 18:35
@CLAassistant
Copy link

CLAassistant commented Nov 26, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@anegg0 anegg0

Labels
s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@anegg0 @CLAassistant