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

XCM Documentation #6774

Open
franciscoaguirre opened this issue Dec 5, 2024 · 0 comments
Open

XCM Documentation #6774

franciscoaguirre opened this issue Dec 5, 2024 · 0 comments
Assignees
Labels
T6-XCM This PR/Issue is related to XCM.

Comments

@franciscoaguirre
Copy link
Contributor

One of the main reasons XCM is regarded as hard is the lack of documentation.
Some simple transfers we have been able to put as extrinsics in pallet-xcm people can use very easily, but as we're moving more and more towards palletXcm.execute we need good documentation to teach developers to craft xcms and use the tools surrounding it.
The XCMv5 release, which removes a lot of barriers of usage, will have a much bigger impact if it comes with the appropriate documentation.

We already have a good place to put documentation on how to configure your parachain for XCM in the rust docs, which we should keep on expanding.
We also have some documentation in the polkadot wiki which, while good, is more of a reference.
We need a place for app development docs. How to interact with a chain via XCM.
These docs should have:

  • How to interact with the chain with PAPI and SubXt
  • Snippets for multiple different scenarios
  • How to use Chopsticks to debug xcms
  • Be available for different versions (V4, V5)
  • Possibly more
@franciscoaguirre franciscoaguirre added the T6-XCM This PR/Issue is related to XCM. label Dec 5, 2024
@franciscoaguirre franciscoaguirre self-assigned this Dec 5, 2024
@acatangiu acatangiu moved this to Todo in Bridges + XCM Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T6-XCM This PR/Issue is related to XCM.
Projects
Status: Todo
Development

No branches or pull requests

1 participant