Closed eshaben closed 3 months ago
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.
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
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