moonbeam-foundation / xcm-sdk

The Moonbeam XCM SDK enables developers to easily transfer assets between chains, either between parachains or between a parachain and the relay chain, within the Polkadot/Kusama ecosystem. With the SDK, you don't need to worry about determining the multilocation of the origin or destination assets or which extrinsics are used on which networks to
https://moonbeam-foundation.github.io/xcm-sdk/latest/
MIT License
14 stars 9 forks source link

Add XCM SDK docs #248

Closed eshaben closed 3 months ago

eshaben commented 5 months ago

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 using mike deploy commands (see mkdocs/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 the gh-pages branch is always open and never manually modified.

πŸ” The current workflow can be summarized as:

There 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:

  1. Go to the settings page of the repo
  2. Under code and automation, click Pages
  3. For the Build and deploy settings, the source should be set to Deploy from a branch and the Branch should be set to 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

changeset-bot[bot] commented 5 months ago

⚠️ No Changeset found

Latest commit: 4451271e1c653c406d00e8cce651c2ca39cee00b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

eshaben commented 4 months ago

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.