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.

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

Merged
merged 17 commits into from
Jul 4, 2024
Merged

Add XCM SDK docs #248

merged 17 commits into from
Jul 4, 2024

Conversation

eshaben
Copy link
Contributor

@eshaben eshaben commented May 8, 2024

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:

  • Make changes and open a PR to be merged into the main branch
  • Run the mike deploy commands locally, which will push up changes automatically to the gh-pages branch of your fork
  • Open a PR to merge your fork changes into the gh-pages branch

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

  • If this requires a documentation change, I have created a PR in [moonbeam-docs] (https://github.com/moonbeam-foundation/moonbeam-docs) repository.
  • If this requires it, I have updated the Readme
  • If necessary, I have updated the examples
  • I have verified if I need to create/update unit tests
  • I have verified if I need to create/update acceptance tests
  • If necessary, I have run acceptance tests on this branch in CI

Copy link

changeset-bot bot commented May 8, 2024

⚠️ No Changeset found

Latest commit: 4451271

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

Copy link
Collaborator

@ekenigs ekenigs left a 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.

Copy link
Collaborator

@ekenigs ekenigs left a 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.

packages/config/src/assets.ts Outdated Show resolved Hide resolved
mkdocs/material-overrides/assets/images/moonbeam-logo.webp Outdated Show resolved Hide resolved
mkdocs/docs/reference/methods.md Show resolved Hide resolved
mkdocs/docs/reference/interfaces.md Show resolved Hide resolved
@eshaben eshaben requested a review from ekenigs June 12, 2024 20:46
@eshaben
Copy link
Contributor Author

eshaben commented Jun 12, 2024

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.

ekenigs
ekenigs previously approved these changes Jun 14, 2024
@eshaben eshaben requested a review from ekenigs July 3, 2024 04:45
@ekenigs ekenigs merged commit e8487c6 into moonbeam-foundation:main Jul 4, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants