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 Docs on GMP vs XCM #895

Merged
merged 10 commits into from May 8, 2024
Merged

Add Docs on GMP vs XCM #895

merged 10 commits into from May 8, 2024

Conversation

themacexpert
Copy link
Contributor

@themacexpert themacexpert commented Mar 27, 2024

Description

Replaces stale content on the future cross-chain integration plans page with a high level comparison of xcm vs GMP and an overview of each. I didn't change .md name of the page and thus have no redirects, but if we want to rename the page we certainly can. The old page didn't have any images and I don't have any images here yet but if we need some to break up the page or add some variety I def can add.

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@themacexpert themacexpert added the A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) label Mar 27, 2024
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a comment on the XCM section, but with that section, we need to try to bring a fresh perspective on the topic so it doesn't seem like a duplicate of the content we already have and the content that Polkadot already has.

I have some ideas for sections that aren't really (at all) content-heavy, but I think could be useful:

  • a quick section on gmp vs xcm that is super explicit so users don't need to read through the two different sections to get an understanding of the differences. maybe this includes a pros and cons type list for each or just bulleted list of differences. I know this wouldn't be long, but we could at least briefly touch on points like the implementation (smart contracts vs runtime-level logic), security, reach, fees, etc.
  • a section on combining gmp and xcm - just to be like hey this is possible for extending your cross-chain applications

learn/features/xchain-plans.md Outdated Show resolved Hide resolved

Recall the old Unix philosophy, where users build tools that do one job and do it well. This is similar to the specialization that we expect to happen to parachains on Polkadot. On Linux, you can combine and compose these purpose-built tools together to achieve higher order effects using a shell-like bash. We anticipate Moonbeam-based smart contracts will provide an analogous “bash-like” environment, where specialized smart contracts and parachain functionality can be composed to achieve higher order goals.
## XCM Overview {: #xcm-overview }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm struggling with this section because I feel like it just duplicates content that we already have on the XCM Overview page.

I do really like the "Happy Path of a Cross-Chain Message" section under GMP, and so I'm thinking that we should try to keep the XCM and GMP sections like apples to apples and have the same sort of section under XCM. Maybe because this content is structured pretty closely to how it is on the overview page, that's where my problem lies, and if we can make it more casual here, and layout the flow of a cross-chain transaction via VMP and then also via HRMP in a similar manner that might be beneficial.

I don't know 🤷‍♀️ -- what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I simplified it a bit to get rid of the XCM overview section and shuffled some things around, also putting the quick reference table in above.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great!

learn/features/xchain-plans.md Outdated Show resolved Hide resolved
@eshaben
Copy link
Contributor

eshaben commented Apr 17, 2024

@albertov19 I requested your review on this as I would like to see what your thoughts are on this

albertov19
albertov19 previously approved these changes Apr 24, 2024
Copy link
Contributor

@albertov19 albertov19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Left some minor feedback.

It would be great to see the typical image of Protocols Moonbeam and Polkadot that we tend to use for MRL at the end

learn/features/xchain-plans.md Outdated Show resolved Hide resolved
learn/features/xchain-plans.md Outdated Show resolved Hide resolved
learn/features/xchain-plans.md Show resolved Hide resolved
Co-authored-by: albertov19 <64150856+albertov19@users.noreply.github.com>
themacexpert and others added 2 commits April 26, 2024 09:07
Co-authored-by: albertov19 <64150856+albertov19@users.noreply.github.com>
albertov19
albertov19 previously approved these changes May 2, 2024
Copy link
Contributor

@albertov19 albertov19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job on this! Just some merge conflicts to be resolved and then this is good to be merged! 🚀

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚢 🚀

@eshaben eshaben merged commit 5c88296 into master May 8, 2024
1 check passed
@eshaben eshaben deleted the themacexpert/xcmgmp branch May 8, 2024 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants