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
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 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
|
||
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 } |
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'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?
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 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.
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.
looks great!
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@albertov19 I requested your review on this as I would like to see what your thoughts are on this |
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.
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
Co-authored-by: albertov19 <64150856+albertov19@users.noreply.github.com>
Co-authored-by: albertov19 <64150856+albertov19@users.noreply.github.com>
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.
LGTM
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.
Great job on this! Just some merge conflicts to be resolved and then this is good to be merged! 🚀
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.
LGTM! 🚢 🚀
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
moonbeam-docs-cn
repo, I have created a ticket for the translations in Jiramoonbeam-mkdocs
to update redirectsmove-pages.py
script to move the pages and update the image paths on the chinese repomoonbeam-docs-cn
compress-images.py
script to compress the images.moonbeam-docs-cn
repo to use the new variablesCorresponding PRs
Please link to any corresponding PRs here.
After Translation Requirements
moonbeam-docs
repo to remove imagesmoonbeam-docs
repo to remove variablesmoonbeam-mkdocs
repo to add redirects for Chinese siteItems to be Updated
Please list any of the items that will need to be added or deleted after the translations are done here.