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

[Feature Request] XCM Documentation Elaboration & Restructure #4541

Closed
9 of 15 tasks
CrackTheCode016 opened this issue Mar 4, 2023 · 1 comment
Closed
9 of 15 tasks
Assignees
Labels
A1 - In Progress Not ready for review yet. docs Related to the docs in general.

Comments

@CrackTheCode016
Copy link
Contributor

CrackTheCode016 commented Mar 4, 2023

This issue is meant to keep track of any discussion and highlight the changes to be made to the XCM section of the wiki.

Currently, the wiki does cover the most relevant concepts but could use much more elaboration and context for how to use XCM and where to look for resources.

A set of guides centering around configuring XCM and relevant parameters would also be beneficial.

As part of this effort, xcm-format should also be updated, as it gives a good technical reference for the wiki to refer to when discussing instructions & registers. I've already started a refactor on my fork.

Page Reorg - for "Learn"

In terms of reorganizing the docs, new pages should be added to highlight other aspects (similar to how Parachains in the wiki are laid out):

  • Introduction to XCM (Cross Consensus Messaging)
  • Transporting XCM Messages - XCMP, HRMP, & VMP
  • XCM Executor, XCVM, & the xcm-simulator
  • XCM Format Instruction & Register Specification

...more may be added as needed!

Each of these pages will hold domain-specific resources for further action (if applicable) and comprehensive info on how to use XCM.

In the future, it may also be beneficial to include things more builder oriented in the "Build" section of the wiki.

Outstanding issues

  • Update XCM use cases to ensure accuracy (add as needed), add common ones
  • Cover XCM v3 changes
  • Comprehensive table of XCM instructions and registers, what they do, and links to their source.
  • Deep dive into the XCM executor and XCVM
  • Document the xcm-pallet
  • Document XCM transport methods
  • Document how fees are handled in XCM
  • Document crucial XCM config aspects, i.e., transactors, traders, barriers, reserves
  • Document XCM weight calculation
  • Document how XCM messages are constructed for the means of transportation
  • Update xcm-format
  • Need more coverage on Asset trapping / claiming mechanisms
  • Discussing trust between chains, and how xcm-config reflects the trust levels.
  • Differences between teleportation, reserves, and which to use.
  • Covering xcm-builder

...more may be added as needed!

@DrW3RK
Copy link
Member

DrW3RK commented Sep 27, 2023

We added the official XCM docs to the Wiki https://wiki.polkadot.network/docs/learn/xcm/introduction

@DrW3RK DrW3RK closed this as completed Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - In Progress Not ready for review yet. docs Related to the docs in general.
Projects
None yet
Development

No branches or pull requests

2 participants