-
Notifications
You must be signed in to change notification settings - Fork 9
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.
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
Add XCM SDK docs #248
Add XCM SDK docs #248
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see in some places:
const sdkInstance = new Sdk();
const transferDataWithoutAccounts = sdkInstance
Sdk()
is not a class so you can't call it with new
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey Erin, good job for the PR, and sorry that we waited so long with it. I notice a few things.
thanks for the review @ekenigs! applied your feedback 🙂 I'll need to go back through and redeploy v1, but I'd like to do that after I get a review of the changes I just pushed, so I only have to redeploy once. |
Description
This PR adds the new XCM SDK docs! 🎉 These are versioned docs, so the docs for v0-v2 are all available in one central place.
For mkdocs, versioning is made possible through mike, which works by creating a new Git commit on the
gh-pages
branch every time a new version of the docs is deployed usingmike deploy
commands (seemkdocs/README.md
). When deploying a particular version, previously-deployed docs for that version are overwritten, but docs for other versions remain untouched. So we'll need to make sure that thegh-pages
branch is always open and never manually modified.🔁 The current workflow can be summarized as:
main
branchmike deploy
commands locally, which will push up changes automatically to thegh-pages
branch of your forkgh-pages
branchThere may be a better way to automate or handle this, but at least with this flow, we'll be able to dictate whether changes result in updating the latest version or publishing a new version.
✅ For initial setup:
gh-pages
Anytime we merge new version changes to the
gh-pages
branch, it will automatically deploy and publish those changes to https://moonbeam-foundation.github.io/xcm-sdk/ 🚀👀 To see how it currently looks, you can checkout my test page: https://eshaben.github.io/xcm-sdk-mkdocs/latest/
Checklist